Class EthDstBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.eth.dst._case.EthDstBuilder
Class that builds
EthDst
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:
EthDst createEthDst(int fooXyzzy, int barBaz) {
return new EthDstBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of EthDst, 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
ConstructorsConstructorDescriptionConstruct an empty builder.EthDstBuilder
(EthDst base) Construct a builder initialized with state from specifiedEthDst
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<EthDst> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthDst>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull EthDst
build()
A newEthDst
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
Return current value associated with the property corresponding toEthDst.getMacAddress()
.byte[]
getMask()
Return current value associated with the property corresponding toEthDst.getMask()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthDst>> augmentationType) Remove an augmentation from this builder's product.setMacAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toEthDst.getMacAddress()
to the specified value.setMask
(byte[] value) Set the property corresponding toEthDst.getMask()
to the specified value.
-
Constructor Details
-
EthDstBuilder
public EthDstBuilder()Construct an empty builder. -
EthDstBuilder
Construct a builder initialized with state from specifiedEthDst
.- Parameters:
base
- EthDst from which the builder should be initialized
-
-
Method Details
-
getMacAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMacAddress()Return current value associated with the property corresponding toEthDst.getMacAddress()
.- Returns:
- current value
-
getMask
public byte[] getMask()Return current value associated with the property corresponding toEthDst.getMask()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthDst>> 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
-
setMacAddress
public EthDstBuilder setMacAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toEthDst.getMacAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMask
Set the property corresponding toEthDst.getMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public EthDstBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EthDst> 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 EthDstBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthDst>> 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 newEthDst
instance.- Returns:
- A new
EthDst
instance.
-