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