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
Class that builds
IpEcn
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:
IpEcn createIpEcn(int fooXyzzy, int barBaz) {
return new IpEcnBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of IpEcn, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.IpEcnBuilder
(IpEcn base) Construct a builder initialized with state from specifiedIpEcn
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull IpEcn
build()
A newIpEcn
instance.static @NonNull IpEcn
empty()
Get empty instance of IpEcn.org.opendaylight.yangtools.yang.common.Uint8
getEcn()
Return current value associated with the property corresponding toIpEcn.getEcn()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn>> augmentationType) Remove an augmentation from this builder's product.setEcn
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toIpEcn.getEcn()
to the specified value.
-
Constructor Details
-
IpEcnBuilder
public IpEcnBuilder()Construct an empty builder. -
IpEcnBuilder
Construct a builder initialized with state from specifiedIpEcn
.- Parameters:
base
- IpEcn from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of IpEcn.- Returns:
- An empty
IpEcn
-
getEcn
public org.opendaylight.yangtools.yang.common.Uint8 getEcn()Return current value associated with the property corresponding toIpEcn.getEcn()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn>> 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
-
setEcn
Set the property corresponding toIpEcn.getEcn()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public IpEcnBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn> 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 IpEcnBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpEcn>> 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
A newIpEcn
instance.- Returns:
- A new
IpEcn
instance.
-