Class BasicSessionAttributeObjectCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.session.attribute.object.session.attribute.object.BasicSessionAttributeObjectCaseBuilder
-
@Generated("mdsal-binding-generator") public class BasicSessionAttributeObjectCaseBuilder extends Object
Class that buildsBasicSessionAttributeObjectCase
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:
BasicSessionAttributeObjectCase createBasicSessionAttributeObjectCase(int fooXyzzy, int barBaz) { return new BasicSessionAttributeObjectCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BasicSessionAttributeObjectCase, 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:
BasicSessionAttributeObjectCase
- 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
-
-
Constructor Summary
Constructors Constructor Description BasicSessionAttributeObjectCaseBuilder()
Construct an empty builder.BasicSessionAttributeObjectCaseBuilder(BasicSessionAttributeObjectCase base)
Construct a builder initialized with state from specifiedBasicSessionAttributeObjectCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BasicSessionAttributeObjectCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BasicSessionAttributeObjectCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicSessionAttributeObjectCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BasicSessionAttributeObjectCase
build()
A newBasicSessionAttributeObjectCase
instance.BasicSessionAttributeObject
getBasicSessionAttributeObject()
Return current value associated with the property corresponding toBasicSessionAttributeObjectCase.getBasicSessionAttributeObject()
.BasicSessionAttributeObjectCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicSessionAttributeObjectCase>> augmentationType)
Remove an augmentation from this builder's product.BasicSessionAttributeObjectCaseBuilder
setBasicSessionAttributeObject(BasicSessionAttributeObject value)
Set the property corresponding toBasicSessionAttributeObjectCase.getBasicSessionAttributeObject()
to the specified value.
-
-
-
Constructor Detail
-
BasicSessionAttributeObjectCaseBuilder
public BasicSessionAttributeObjectCaseBuilder()
Construct an empty builder.
-
BasicSessionAttributeObjectCaseBuilder
public BasicSessionAttributeObjectCaseBuilder(BasicSessionAttributeObjectCase base)
Construct a builder initialized with state from specifiedBasicSessionAttributeObjectCase
.- Parameters:
base
- BasicSessionAttributeObjectCase from which the builder should be initialized
-
-
Method Detail
-
getBasicSessionAttributeObject
public BasicSessionAttributeObject getBasicSessionAttributeObject()
Return current value associated with the property corresponding toBasicSessionAttributeObjectCase.getBasicSessionAttributeObject()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicSessionAttributeObjectCase>> 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
-
setBasicSessionAttributeObject
public BasicSessionAttributeObjectCaseBuilder setBasicSessionAttributeObject(BasicSessionAttributeObject value)
Set the property corresponding toBasicSessionAttributeObjectCase.getBasicSessionAttributeObject()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BasicSessionAttributeObjectCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BasicSessionAttributeObjectCase> 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 BasicSessionAttributeObjectCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BasicSessionAttributeObjectCase>> 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
public @NonNull BasicSessionAttributeObjectCase build()
A newBasicSessionAttributeObjectCase
instance.- Returns:
- A new
BasicSessionAttributeObjectCase
instance.
-
-