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