Class ArpTargetHardwareAddressBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.arp.match.fields.ArpTargetHardwareAddressBuilder
Class that builds
ArpTargetHardwareAddress
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:
ArpTargetHardwareAddress createArpTargetHardwareAddress(int fooXyzzy, int barBaz) {
return new ArpTargetHardwareAddressBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ArpTargetHardwareAddress, 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 specifiedArpTargetHardwareAddress
.Construct a new builder initialized from specifiedMacAddressFilter
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<ArpTargetHardwareAddress> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpTargetHardwareAddress>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ArpTargetHardwareAddress
build()
A newArpTargetHardwareAddress
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
Return current value associated with the property corresponding toMacAddressFilter.getAddress()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getMask()
Return current value associated with the property corresponding toMacAddressFilter.getMask()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpTargetHardwareAddress>> augmentationType) Remove an augmentation from this builder's product.setAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toMacAddressFilter.getAddress()
to the specified value.setMask
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toMacAddressFilter.getMask()
to the specified value.
-
Constructor Details
-
ArpTargetHardwareAddressBuilder
public ArpTargetHardwareAddressBuilder()Construct an empty builder. -
ArpTargetHardwareAddressBuilder
Construct a new builder initialized from specifiedMacAddressFilter
.- Parameters:
arg
- MacAddressFilter from which the builder should be initialized
-
ArpTargetHardwareAddressBuilder
Construct a builder initialized with state from specifiedArpTargetHardwareAddress
.- Parameters:
base
- ArpTargetHardwareAddress from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getAddress()Return current value associated with the property corresponding toMacAddressFilter.getAddress()
.- Returns:
- current value
-
getMask
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMask()Return current value associated with the property corresponding toMacAddressFilter.getMask()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpTargetHardwareAddress>> 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
-
setAddress
public ArpTargetHardwareAddressBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toMacAddressFilter.getAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMask
public ArpTargetHardwareAddressBuilder setMask(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toMacAddressFilter.getMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ArpTargetHardwareAddressBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ArpTargetHardwareAddress> 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 ArpTargetHardwareAddressBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ArpTargetHardwareAddress>> 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 newArpTargetHardwareAddress
instance.- Returns:
- A new
ArpTargetHardwareAddress
instance.
-