Class DstBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.reg.load.grouping.nx.reg.load.DstBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Dst>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Dst,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class DstBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Dst>
Class that buildsDstBuilder
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:
DstBuilder createTarget(int fooXyzzy, int barBaz) { return new DstBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DstBuilder, 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 oportunities, 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:
DstBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description DstBuilder()
DstBuilder(DstChoiceGrouping arg)
DstBuilder(Dst base)
DstBuilder(RangeGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DstBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Dst>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Dst> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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)
Dst
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.DstChoice
getDstChoice()
org.opendaylight.yangtools.yang.common.Uint16
getEnd()
org.opendaylight.yangtools.yang.common.Uint16
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)
DstBuilder
setEnd(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEnd(Uint16)
instead.DstBuilder
setEnd(org.opendaylight.yangtools.yang.common.Uint16 value)
DstBuilder
setStart(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetStart(Uint16)
instead.DstBuilder
setStart(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
DstBuilder
public DstBuilder()
-
DstBuilder
public DstBuilder(DstChoiceGrouping arg)
-
DstBuilder
public DstBuilder(RangeGrouping arg)
-
DstBuilder
public DstBuilder(Dst base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.RangeGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.DstChoiceGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getDstChoice
public DstChoice getDstChoice()
-
getEnd
public org.opendaylight.yangtools.yang.common.Uint16 getEnd()
-
getStart
public org.opendaylight.yangtools.yang.common.Uint16 getStart()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Dst>> E$$ augmentation(Class<E$$> augmentationType)
-
setDstChoice
public DstBuilder setDstChoice(DstChoice value)
-
setEnd
public DstBuilder setEnd(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setEnd
@Deprecated(forRemoval=true) public DstBuilder setEnd(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEnd(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setStart
public DstBuilder setStart(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setStart
@Deprecated(forRemoval=true) public DstBuilder setStart(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetStart(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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
-
addAugmentation
@Deprecated(forRemoval=true) public DstBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Dst>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Dst> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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
-
build
public Dst build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Dst>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Dst,IllegalArgumentException>
-
-