Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.close.object
Class CCloseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.close.object.CCloseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<CClose>
,org.opendaylight.yangtools.concepts.CheckedBuilder<CClose,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class CCloseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<CClose>
Class that buildsCCloseBuilder
instances. Overall design of the class is that of a fluent interface, where method chaining is used.In general, this class is supposed to be used like this template:
CCloseBuilder createTarget(int fooXyzzy, int barBaz) { return new CCloseBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CCloseBuilder, as instances can be freely passed around without worrying about synchronization issues.
As a side note: method chaining results in:
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
build()
, which is then returned from the method - better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
- better optimization oportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
- See Also:
CCloseBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description CCloseBuilder()
CCloseBuilder(CClose base)
CCloseBuilder(Object arg)
CCloseBuilder(ObjectHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CCloseBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CClose>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<CClose> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CClose>>
E$$augmentation(Class<E$$> augmentationType)
CClose
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getReason()
Tlvs
getTlvs()
Boolean
isIgnore()
Boolean
isProcessingRule()
CCloseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CClose>> augmentationType)
CCloseBuilder
setIgnore(Boolean value)
CCloseBuilder
setProcessingRule(Boolean value)
CCloseBuilder
setReason(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setReason(Uint8)} instead.CCloseBuilder
setReason(org.opendaylight.yangtools.yang.common.Uint8 value)
CCloseBuilder
setTlvs(Tlvs value)
-
-
-
Constructor Detail
-
CCloseBuilder
public CCloseBuilder()
-
CCloseBuilder
public CCloseBuilder(Object arg)
-
CCloseBuilder
public CCloseBuilder(ObjectHeader arg)
-
CCloseBuilder
public CCloseBuilder(CClose base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getReason
public org.opendaylight.yangtools.yang.common.Uint8 getReason()
-
getTlvs
public Tlvs getTlvs()
-
isIgnore
public Boolean isIgnore()
-
isProcessingRule
public Boolean isProcessingRule()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CClose>> E$$ augmentation(Class<E$$> augmentationType)
-
setReason
public CCloseBuilder setReason(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setReason
@Deprecated(forRemoval=true) public CCloseBuilder setReason(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setReason(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTlvs
public CCloseBuilder setTlvs(Tlvs value)
-
setIgnore
public CCloseBuilder setIgnore(Boolean value)
-
setProcessingRule
public CCloseBuilder setProcessingRule(Boolean value)
-
addAugmentation
public CCloseBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CClose>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<CClose> augmentationValue)
-
removeAugmentation
public CCloseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CClose>> augmentationType)
-
build
public CClose build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<CClose>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<CClose,IllegalArgumentException>
-
-