Class SetFieldCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.SetFieldCaseBuilder
-
@Generated("mdsal-binding-generator") public class SetFieldCaseBuilder extends Object
Class that buildsSetFieldCase
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:
SetFieldCase createSetFieldCase(int fooXyzzy, int barBaz) { return new SetFieldCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetFieldCase, 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:
SetFieldCase
- 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 SetFieldCaseBuilder()
Construct an empty builder.SetFieldCaseBuilder(SetFieldCase base)
Construct a builder initialized with state from specifiedSetFieldCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetFieldCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SetFieldCase
build()
A newSetFieldCase
instance.SetField
getSetField()
Return current value associated with the property corresponding toSetFieldCase.getSetField()
.SetFieldCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldCase>> augmentationType)
Remove an augmentation from this builder's product.SetFieldCaseBuilder
setSetField(SetField value)
Set the property corresponding toSetFieldCase.getSetField()
to the specified value.
-
-
-
Constructor Detail
-
SetFieldCaseBuilder
public SetFieldCaseBuilder()
Construct an empty builder.
-
SetFieldCaseBuilder
public SetFieldCaseBuilder(SetFieldCase base)
Construct a builder initialized with state from specifiedSetFieldCase
.- Parameters:
base
- SetFieldCase from which the builder should be initialized
-
-
Method Detail
-
getSetField
public SetField getSetField()
Return current value associated with the property corresponding toSetFieldCase.getSetField()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldCase>> 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
-
setSetField
public SetFieldCaseBuilder setSetField(SetField value)
Set the property corresponding toSetFieldCase.getSetField()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SetFieldCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldCase> 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 SetFieldCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldCase>> 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 SetFieldCase build()
A newSetFieldCase
instance.- Returns:
- A new
SetFieldCase
instance.
-
-