Class Nshc1ValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.nx.match.nshc._1.grouping.Nshc1ValuesBuilder
-
@Generated("mdsal-binding-generator") public class Nshc1ValuesBuilder extends Object
Class that buildsNshc1Values
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:
Nshc1Values createNshc1Values(int fooXyzzy, int barBaz) { return new Nshc1ValuesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Nshc1Values, 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:
Nshc1Values
- 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 Nshc1ValuesBuilder()
Construct an empty builder.Nshc1ValuesBuilder(Nshc1Values base)
Construct a builder initialized with state from specifiedNshc1Values
.Nshc1ValuesBuilder(OfjNxmNxMatchNshcGrouping arg)
Construct a new builder initialized from specifiedOfjNxmNxMatchNshcGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Nshc1ValuesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Nshc1Values> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Nshc1Values>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Nshc1Values
build()
A newNshc1Values
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getMask()
Return current value associated with the property corresponding toOfjNxmNxMatchNshcGrouping.getMask()
.org.opendaylight.yangtools.yang.common.Uint32
getNshc()
Return current value associated with the property corresponding toOfjNxmNxMatchNshcGrouping.getNshc()
.Nshc1ValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Nshc1Values>> augmentationType)
Remove an augmentation from this builder's product.Nshc1ValuesBuilder
setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfjNxmNxMatchNshcGrouping.getMask()
to the specified value.Nshc1ValuesBuilder
setNshc(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfjNxmNxMatchNshcGrouping.getNshc()
to the specified value.
-
-
-
Constructor Detail
-
Nshc1ValuesBuilder
public Nshc1ValuesBuilder()
Construct an empty builder.
-
Nshc1ValuesBuilder
public Nshc1ValuesBuilder(OfjNxmNxMatchNshcGrouping arg)
Construct a new builder initialized from specifiedOfjNxmNxMatchNshcGrouping
.- Parameters:
arg
- OfjNxmNxMatchNshcGrouping from which the builder should be initialized
-
Nshc1ValuesBuilder
public Nshc1ValuesBuilder(Nshc1Values base)
Construct a builder initialized with state from specifiedNshc1Values
.- Parameters:
base
- Nshc1Values 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
-
getMask
public org.opendaylight.yangtools.yang.common.Uint32 getMask()
Return current value associated with the property corresponding toOfjNxmNxMatchNshcGrouping.getMask()
.- Returns:
- current value
-
getNshc
public org.opendaylight.yangtools.yang.common.Uint32 getNshc()
Return current value associated with the property corresponding toOfjNxmNxMatchNshcGrouping.getNshc()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Nshc1Values>> 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
-
setMask
public Nshc1ValuesBuilder setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfjNxmNxMatchNshcGrouping.getMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNshc
public Nshc1ValuesBuilder setNshc(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfjNxmNxMatchNshcGrouping.getNshc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Nshc1ValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Nshc1Values> 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 Nshc1ValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Nshc1Values>> 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 Nshc1Values build()
A newNshc1Values
instance.- Returns:
- A new
Nshc1Values
instance.
-
-