Class SrcBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.output.reg.grouping.nx.output.reg.SrcBuilder
-
@Generated("mdsal-binding-generator") public class SrcBuilder extends Object
Class that buildsSrc
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:
Src createSrc(int fooXyzzy, int barBaz) { return new SrcBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Src, 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:
Src
- 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 SrcBuilder()
Construct an empty builder.SrcBuilder(Src base)
Construct a builder initialized with state from specifiedSrc
.SrcBuilder(SrcChoiceGrouping arg)
Construct a new builder initialized from specifiedSrcChoiceGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SrcBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Src> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Src>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Src
build()
A newSrc
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getOfsNbits()
Return current value associated with the property corresponding toSrc.getOfsNbits()
.SrcChoice
getSrcChoice()
Return current value associated with the property corresponding toSrcChoiceGrouping.getSrcChoice()
.SrcBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Src>> augmentationType)
Remove an augmentation from this builder's product.SrcBuilder
setOfsNbits(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toSrc.getOfsNbits()
to the specified value.SrcBuilder
setSrcChoice(SrcChoice value)
Set the property corresponding toSrcChoiceGrouping.getSrcChoice()
to the specified value.
-
-
-
Constructor Detail
-
SrcBuilder
public SrcBuilder()
Construct an empty builder.
-
SrcBuilder
public SrcBuilder(SrcChoiceGrouping arg)
Construct a new builder initialized from specifiedSrcChoiceGrouping
.- Parameters:
arg
- SrcChoiceGrouping 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
-
getOfsNbits
public org.opendaylight.yangtools.yang.common.Uint16 getOfsNbits()
Return current value associated with the property corresponding toSrc.getOfsNbits()
.- Returns:
- current value
-
getSrcChoice
public SrcChoice getSrcChoice()
Return current value associated with the property corresponding toSrcChoiceGrouping.getSrcChoice()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Src>> 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
-
setOfsNbits
public SrcBuilder setOfsNbits(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toSrc.getOfsNbits()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSrcChoice
public SrcBuilder setSrcChoice(SrcChoice value)
Set the property corresponding toSrcChoiceGrouping.getSrcChoice()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SrcBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Src> 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 SrcBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Src>> 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
-
-