Class DstBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.multipath.grouping.nx.multipath.DstBuilder
-
@Generated("mdsal-binding-generator") public class DstBuilder extends Object
Class that buildsDst
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:
Dst createDst(int fooXyzzy, int barBaz) { return new DstBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Dst, 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:
Dst
- 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 DstBuilder()
Construct an empty builder.DstBuilder(DstChoiceGrouping arg)
Construct a new builder initialized from specifiedDstChoiceGrouping
.DstBuilder(Dst base)
Construct a builder initialized with state from specifiedDst
.DstBuilder(RangeGrouping arg)
Construct a new builder initialized from specifiedRangeGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DstBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Dst> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Dst>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Dst
build()
A newDst
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.DstChoice
getDstChoice()
Return current value associated with the property corresponding toDstChoiceGrouping.getDstChoice()
.org.opendaylight.yangtools.yang.common.Uint16
getEnd()
Return current value associated with the property corresponding toRangeGrouping.getEnd()
.org.opendaylight.yangtools.yang.common.Uint16
getStart()
Return current value associated with the property corresponding toRangeGrouping.getStart()
.DstBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Dst>> augmentationType)
Remove an augmentation from this builder's product.DstBuilder
setDstChoice(DstChoice value)
Set the property corresponding toDstChoiceGrouping.getDstChoice()
to the specified value.DstBuilder
setEnd(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toRangeGrouping.getEnd()
to the specified value.DstBuilder
setStart(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toRangeGrouping.getStart()
to the specified value.
-
-
-
Constructor Detail
-
DstBuilder
public DstBuilder()
Construct an empty builder.
-
DstBuilder
public DstBuilder(DstChoiceGrouping arg)
Construct a new builder initialized from specifiedDstChoiceGrouping
.- Parameters:
arg
- DstChoiceGrouping from which the builder should be initialized
-
DstBuilder
public DstBuilder(RangeGrouping arg)
Construct a new builder initialized from specifiedRangeGrouping
.- Parameters:
arg
- RangeGrouping from which the builder should be initialized
-
-
Method Detail
-
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
-
getDstChoice
public DstChoice getDstChoice()
Return current value associated with the property corresponding toDstChoiceGrouping.getDstChoice()
.- Returns:
- current value
-
getEnd
public org.opendaylight.yangtools.yang.common.Uint16 getEnd()
Return current value associated with the property corresponding toRangeGrouping.getEnd()
.- Returns:
- current value
-
getStart
public org.opendaylight.yangtools.yang.common.Uint16 getStart()
Return current value associated with the property corresponding toRangeGrouping.getStart()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Dst>> 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
-
setDstChoice
public DstBuilder setDstChoice(DstChoice value)
Set the property corresponding toDstChoiceGrouping.getDstChoice()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEnd
public DstBuilder setEnd(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toRangeGrouping.getEnd()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStart
public DstBuilder setStart(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toRangeGrouping.getStart()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DstBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Dst> 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 DstBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Dst>> 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
-
-