Class Nshc1ValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.nx.match.nshc._1.grouping.Nshc1ValuesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Nshc1Values>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Nshc1Values,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Nshc1ValuesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Nshc1Values>
Class that buildsNshc1ValuesBuilder
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:
Nshc1ValuesBuilder createTarget(int fooXyzzy, int barBaz) { return new Nshc1ValuesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Nshc1ValuesBuilder, 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:
Nshc1ValuesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Nshc1ValuesBuilder()
Nshc1ValuesBuilder(Nshc1Values base)
Nshc1ValuesBuilder(OfjNxmNxMatchNshcGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
Nshc1Values
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getMask()
org.opendaylight.yangtools.yang.common.Uint32
getNshc()
Nshc1ValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Nshc1Values>> augmentationType)
Remove an augmentation from this builder's product.Nshc1ValuesBuilder
setMask(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMask(Uint32)
instead.Nshc1ValuesBuilder
setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
Nshc1ValuesBuilder
setNshc(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNshc(Uint32)
instead.Nshc1ValuesBuilder
setNshc(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
Nshc1ValuesBuilder
public Nshc1ValuesBuilder()
-
Nshc1ValuesBuilder
public Nshc1ValuesBuilder(OfjNxmNxMatchNshcGrouping arg)
-
Nshc1ValuesBuilder
public Nshc1ValuesBuilder(Nshc1Values 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.openflowjava.nx.match.rev140421.OfjNxmNxMatchNshcGrouping
- 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()
-
getNshc
public org.opendaylight.yangtools.yang.common.Uint32 getNshc()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Nshc1Values>> E$$ augmentation(Class<E$$> augmentationType)
-
setMask
public Nshc1ValuesBuilder setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMask
@Deprecated(forRemoval=true) public Nshc1ValuesBuilder setMask(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMask(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setNshc
public Nshc1ValuesBuilder setNshc(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setNshc
@Deprecated(forRemoval=true) public Nshc1ValuesBuilder setNshc(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNshc(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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 Nshc1Values build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Nshc1Values>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Nshc1Values,IllegalArgumentException>
-
-