Class Nshc2ValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.nx.match.nshc._2.grouping.Nshc2ValuesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Nshc2Values>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Nshc2Values,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class Nshc2ValuesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Nshc2Values>
Class that buildsNshc2ValuesBuilder
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:
Nshc2ValuesBuilder createTarget(int fooXyzzy, int barBaz) { return new Nshc2ValuesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Nshc2ValuesBuilder, 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:
Nshc2ValuesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Nshc2ValuesBuilder()
Nshc2ValuesBuilder(Nshc2Values base)
Nshc2ValuesBuilder(OfjNxmNxMatchNshcGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Nshc2ValuesBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Nshc2Values>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Nshc2Values> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Nshc2Values>>
E$$augmentation(Class<E$$> augmentationType)
Nshc2Values
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()
Nshc2ValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Nshc2Values>> augmentationType)
Nshc2ValuesBuilder
setMask(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMask(Uint32)} instead.Nshc2ValuesBuilder
setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
Nshc2ValuesBuilder
setNshc(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setNshc(Uint32)} instead.Nshc2ValuesBuilder
setNshc(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
Nshc2ValuesBuilder
public Nshc2ValuesBuilder()
-
Nshc2ValuesBuilder
public Nshc2ValuesBuilder(OfjNxmNxMatchNshcGrouping arg)
-
Nshc2ValuesBuilder
public Nshc2ValuesBuilder(Nshc2Values 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
-
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<Nshc2Values>> E$$ augmentation(Class<E$$> augmentationType)
-
setMask
public Nshc2ValuesBuilder setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMask
@Deprecated(forRemoval=true) public Nshc2ValuesBuilder setMask(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMask(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setNshc
public Nshc2ValuesBuilder setNshc(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setNshc
@Deprecated(forRemoval=true) public Nshc2ValuesBuilder setNshc(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setNshc(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public Nshc2ValuesBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Nshc2Values>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Nshc2Values> augmentationValue)
-
removeAugmentation
public Nshc2ValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Nshc2Values>> augmentationType)
-
build
public Nshc2Values build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Nshc2Values>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Nshc2Values,IllegalArgumentException>
-
-