Class IpEcnCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.IpEcnCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpEcnCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpEcnCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IpEcnCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<IpEcnCase>
Class that buildsIpEcnCase
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:
IpEcnCase createIpEcnCase(int fooXyzzy, int barBaz) { return new IpEcnCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpEcnCase, 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:
IpEcnCase
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpEcnCaseBuilder()
IpEcnCaseBuilder(IpEcnCase base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IpEcnCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpEcnCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcnCase>>
E$$augmentation(Class<E$$> augmentationType)
IpEcnCase
build()
IpEcn
getIpEcn()
IpEcnCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcnCase>> augmentationType)
Remove an augmentation from this builder's product.IpEcnCaseBuilder
setIpEcn(IpEcn value)
-
-
-
Constructor Detail
-
IpEcnCaseBuilder
public IpEcnCaseBuilder()
-
IpEcnCaseBuilder
public IpEcnCaseBuilder(IpEcnCase base)
-
-
Method Detail
-
getIpEcn
public IpEcn getIpEcn()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcnCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setIpEcn
public IpEcnCaseBuilder setIpEcn(IpEcn value)
-
addAugmentation
public IpEcnCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpEcnCase> 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 IpEcnCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcnCase>> 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 IpEcnCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IpEcnCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IpEcnCase,IllegalArgumentException>
-
-