Class GeneralizedLabelBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.label.subobject.label.type.generalized.label._case.GeneralizedLabelBuilder
Class that builds
GeneralizedLabel
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:
GeneralizedLabel createGeneralizedLabel(int fooXyzzy, int barBaz) {
return new GeneralizedLabelBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of GeneralizedLabel, 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.Construct a new builder initialized from specifiedCLabel
.Construct a new builder initialized from specifiedGeneralizedLabel
.Construct a builder initialized with state from specifiedGeneralizedLabel
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<GeneralizedLabel> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GeneralizedLabel>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull GeneralizedLabel
build()
A newGeneralizedLabel
instance.static @NonNull GeneralizedLabel
empty()
Get empty instance of GeneralizedLabel.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.byte[]
Return current value associated with the property corresponding toGeneralizedLabel.getGeneralizedLabel()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GeneralizedLabel>> augmentationType) Remove an augmentation from this builder's product.setGeneralizedLabel
(byte[] value) Set the property corresponding toGeneralizedLabel.getGeneralizedLabel()
to the specified value.
-
Constructor Details
-
GeneralizedLabelBuilder
public GeneralizedLabelBuilder()Construct an empty builder. -
GeneralizedLabelBuilder
Construct a new builder initialized from specifiedGeneralizedLabel
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.GeneralizedLabel from which the builder should be initialized
-
GeneralizedLabelBuilder
Construct a new builder initialized from specifiedCLabel
.- Parameters:
arg
- CLabel from which the builder should be initialized
-
GeneralizedLabelBuilder
Construct a builder initialized with state from specifiedGeneralizedLabel
.- Parameters:
base
- GeneralizedLabel 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
-
empty
Get empty instance of GeneralizedLabel.- Returns:
- An empty
GeneralizedLabel
-
getGeneralizedLabel
public byte[] getGeneralizedLabel()Return current value associated with the property corresponding toGeneralizedLabel.getGeneralizedLabel()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GeneralizedLabel>> 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
-
setGeneralizedLabel
Set the property corresponding toGeneralizedLabel.getGeneralizedLabel()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public GeneralizedLabelBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GeneralizedLabel> 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 GeneralizedLabelBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GeneralizedLabel>> 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 newGeneralizedLabel
instance.- Returns:
- A new
GeneralizedLabel
instance.
-