Class LacpAutoGeneratedBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.esi.esi.lacp.auto.generated._case.LacpAutoGeneratedBuilder
Class that builds
LacpAutoGenerated
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:
LacpAutoGenerated createLacpAutoGenerated(int fooXyzzy, int barBaz) {
return new LacpAutoGeneratedBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of LacpAutoGenerated, 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.Construct a builder initialized with state from specifiedLacpAutoGenerated
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<LacpAutoGenerated> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LacpAutoGenerated>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull LacpAutoGenerated
build()
A newLacpAutoGenerated
instance.static @NonNull LacpAutoGenerated
empty()
Get empty instance of LacpAutoGenerated.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
Return current value associated with the property corresponding toLacpAutoGenerated.getCeLacpMacAddress()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toLacpAutoGenerated.getCeLacpPortKey()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LacpAutoGenerated>> augmentationType) Remove an augmentation from this builder's product.setCeLacpMacAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toLacpAutoGenerated.getCeLacpMacAddress()
to the specified value.setCeLacpPortKey
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toLacpAutoGenerated.getCeLacpPortKey()
to the specified value.
-
Constructor Details
-
LacpAutoGeneratedBuilder
public LacpAutoGeneratedBuilder()Construct an empty builder. -
LacpAutoGeneratedBuilder
Construct a builder initialized with state from specifiedLacpAutoGenerated
.- Parameters:
base
- LacpAutoGenerated from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of LacpAutoGenerated.- Returns:
- An empty
LacpAutoGenerated
-
getCeLacpMacAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getCeLacpMacAddress()Return current value associated with the property corresponding toLacpAutoGenerated.getCeLacpMacAddress()
.- Returns:
- current value
-
getCeLacpPortKey
public org.opendaylight.yangtools.yang.common.Uint16 getCeLacpPortKey()Return current value associated with the property corresponding toLacpAutoGenerated.getCeLacpPortKey()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LacpAutoGenerated>> 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
-
setCeLacpMacAddress
public LacpAutoGeneratedBuilder setCeLacpMacAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toLacpAutoGenerated.getCeLacpMacAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCeLacpPortKey
public LacpAutoGeneratedBuilder setCeLacpPortKey(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toLacpAutoGenerated.getCeLacpPortKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LacpAutoGeneratedBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LacpAutoGenerated> 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 LacpAutoGeneratedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LacpAutoGenerated>> 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 newLacpAutoGenerated
instance.- Returns:
- A new
LacpAutoGenerated
instance.
-