Class IpEcnBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.ip.ecn._case.IpEcnBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpEcn>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpEcn,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class IpEcnBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<IpEcn>
Class that buildsIpEcnBuilder
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:
IpEcnBuilder createTarget(int fooXyzzy, int barBaz) { return new IpEcnBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpEcnBuilder, 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:
IpEcnBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpEcnBuilder()
IpEcnBuilder(IpEcn base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IpEcnBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn>>
E$$augmentation(Class<E$$> augmentationType)
IpEcn
build()
org.opendaylight.yangtools.yang.common.Uint8
getEcn()
IpEcnBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn>> augmentationType)
IpEcnBuilder
setEcn(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setEcn(Uint8)} instead.IpEcnBuilder
setEcn(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
IpEcnBuilder
public IpEcnBuilder()
-
IpEcnBuilder
public IpEcnBuilder(IpEcn base)
-
-
Method Detail
-
getEcn
public org.opendaylight.yangtools.yang.common.Uint8 getEcn()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn>> E$$ augmentation(Class<E$$> augmentationType)
-
setEcn
public IpEcnBuilder setEcn(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setEcn
@Deprecated(forRemoval=true) public IpEcnBuilder setEcn(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setEcn(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public IpEcnBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn> augmentationValue)
-
removeAugmentation
public IpEcnBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn>> augmentationType)
-
build
public IpEcn build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IpEcn>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IpEcn,IllegalArgumentException>
-
-