Class SrRroTypeBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.pcinitiate.pcinitiate.message.requests.rro.subobject.subobject.type.SrRroTypeBuilder
Class that builds
SrRroType
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:
SrRroType createSrRroType(int fooXyzzy, int barBaz) {
return new SrRroTypeBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SrRroType, 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 opportunities, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.SrRroTypeBuilder
(SrRroType base) Construct a builder initialized with state from specifiedSrRroType
.Construct a new builder initialized from specifiedSrRroSubobject
.Construct a new builder initialized from specifiedSrSubobject
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<SrRroType> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrRroType>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull SrRroType
build()
A newSrRroType
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.getCFlag()
Return current value associated with the property corresponding toSrSubobject.getCFlag()
.getMFlag()
Return current value associated with the property corresponding toSrSubobject.getMFlag()
.getNai()
Return current value associated with the property corresponding toSrSubobject.getNai()
.Return current value associated with the property corresponding toSrSubobject.getNaiType()
.org.opendaylight.yangtools.yang.common.Uint32
getSid()
Return current value associated with the property corresponding toSrSubobject.getSid()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrRroType>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toSrSubobject.getCFlag()
to the specified value.Set the property corresponding toSrSubobject.getMFlag()
to the specified value.Set the property corresponding toSrSubobject.getNai()
to the specified value.setNaiType
(NaiType value) Set the property corresponding toSrSubobject.getNaiType()
to the specified value.setSid
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toSrSubobject.getSid()
to the specified value.
-
Constructor Details
-
SrRroTypeBuilder
public SrRroTypeBuilder()Construct an empty builder. -
SrRroTypeBuilder
Construct a new builder initialized from specifiedSrRroSubobject
.- Parameters:
arg
- SrRroSubobject from which the builder should be initialized
-
SrRroTypeBuilder
Construct a new builder initialized from specifiedSrSubobject
.- Parameters:
arg
- SrSubobject from which the builder should be initialized
-
SrRroTypeBuilder
Construct a builder initialized with state from specifiedSrRroType
.- Parameters:
base
- SrRroType from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getCFlag
Return current value associated with the property corresponding toSrSubobject.getCFlag()
.- Returns:
- current value
-
getMFlag
Return current value associated with the property corresponding toSrSubobject.getMFlag()
.- Returns:
- current value
-
getNai
Return current value associated with the property corresponding toSrSubobject.getNai()
.- Returns:
- current value
-
getNaiType
Return current value associated with the property corresponding toSrSubobject.getNaiType()
.- Returns:
- current value
-
getSid
public org.opendaylight.yangtools.yang.common.Uint32 getSid()Return current value associated with the property corresponding toSrSubobject.getSid()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrRroType>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setCFlag
Set the property corresponding toSrSubobject.getCFlag()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMFlag
Set the property corresponding toSrSubobject.getMFlag()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNai
Set the property corresponding toSrSubobject.getNai()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNaiType
Set the property corresponding toSrSubobject.getNaiType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSid
Set the property corresponding toSrSubobject.getSid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SrRroTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SrRroType> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public SrRroTypeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrRroType>> augmentationType) Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
A newSrRroType
instance.- Returns:
- A new
SrRroType
instance.
-