Class Type1LabelCaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.label.subobject.label.type.Type1LabelCaseBuilder
Class that builds
Type1LabelCase
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:
Type1LabelCase createType1LabelCase(int fooXyzzy, int barBaz) {
return new Type1LabelCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Type1LabelCase, 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 builder initialized with state from specifiedType1LabelCase
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Type1LabelCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Type1LabelCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Type1LabelCase
build()
A newType1LabelCase
instance.Return current value associated with the property corresponding toType1LabelCase.getType1Label()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Type1LabelCase>> augmentationType) Remove an augmentation from this builder's product.setType1Label
(Type1Label value) Set the property corresponding toType1LabelCase.getType1Label()
to the specified value.
-
Constructor Details
-
Type1LabelCaseBuilder
public Type1LabelCaseBuilder()Construct an empty builder. -
Type1LabelCaseBuilder
Construct a builder initialized with state from specifiedType1LabelCase
.- Parameters:
base
- Type1LabelCase from which the builder should be initialized
-
-
Method Details
-
getType1Label
Return current value associated with the property corresponding toType1LabelCase.getType1Label()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Type1LabelCase>> 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
-
setType1Label
Set the property corresponding toType1LabelCase.getType1Label()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Type1LabelCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Type1LabelCase> 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 Type1LabelCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Type1LabelCase>> 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 newType1LabelCase
instance.- Returns:
- A new
Type1LabelCase
instance.
-