Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.ted.rev131021.srlg.attributes
Class SrlgValuesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.ted.rev131021.srlg.attributes.SrlgValuesBuilder
Class that builds
SrlgValues
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:
SrlgValues createSrlgValues(int fooXyzzy, int barBaz) {
return new SrlgValuesBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SrlgValues, 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.SrlgValuesBuilder
(SrlgValues base) Construct a builder initialized with state from specifiedSrlgValues
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull SrlgValues
build()
A newSrlgValues
instance.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toSrlgValues.getSrlgValue()
.key()
Return current value associated with the property corresponding toSrlgValues.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues>> augmentationType) Remove an augmentation from this builder's product.setSrlgValue
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toSrlgValues.getSrlgValue()
to the specified value.withKey
(SrlgValuesKey key) Set the key value corresponding toSrlgValues.key()
to the specified value.
-
Constructor Details
-
SrlgValuesBuilder
public SrlgValuesBuilder()Construct an empty builder. -
SrlgValuesBuilder
Construct a builder initialized with state from specifiedSrlgValues
.- Parameters:
base
- SrlgValues from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toSrlgValues.key()
.- Returns:
- current value
-
getSrlgValue
public org.opendaylight.yangtools.yang.common.Uint32 getSrlgValue()Return current value associated with the property corresponding toSrlgValues.getSrlgValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues>> 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
-
withKey
Set the key value corresponding toSrlgValues.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setSrlgValue
Set the property corresponding toSrlgValues.getSrlgValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SrlgValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues> 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 SrlgValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SrlgValues>> 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 newSrlgValues
instance.- Returns:
- A new
SrlgValues
instance.
-