Class RemoteMcastMacsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.RemoteMcastMacsBuilder
Class that builds
RemoteMcastMacs
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:
RemoteMcastMacs createRemoteMcastMacs(int fooXyzzy, int barBaz) {
return new RemoteMcastMacsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of RemoteMcastMacs, 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 specifiedRemoteMcastMacs
.Construct a new builder initialized from specifiedHwvtepMacTableGenericAttributes
.Construct a new builder initialized from specifiedHwvtepMcastMacTableAttributes
.Construct a new builder initialized from specifiedHwvtepPhysicalLocatorSetAttributes
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<RemoteMcastMacs> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoteMcastMacs>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull RemoteMcastMacs
build()
A newRemoteMcastMacs
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.inet.types.rev130715.IpAddress
Return current value associated with the property corresponding toHwvtepMcastMacTableAttributes.getIpaddr()
.Return current value associated with the property corresponding toHwvtepPhysicalLocatorSetAttributes.getLocatorSet()
.Return current value associated with the property corresponding toHwvtepMacTableGenericAttributes.getLogicalSwitchRef()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
Return current value associated with the property corresponding toHwvtepMacTableGenericAttributes.getMacEntryKey()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
Return current value associated with the property corresponding toHwvtepMacTableGenericAttributes.getMacEntryUuid()
.key()
Return current value associated with the property corresponding toRemoteMcastMacs.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoteMcastMacs>> augmentationType) Remove an augmentation from this builder's product.setIpaddr
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value) Set the property corresponding toHwvtepMcastMacTableAttributes.getIpaddr()
to the specified value.setLocatorSet
(List<LocatorSet> values) Set the property corresponding toHwvtepPhysicalLocatorSetAttributes.getLocatorSet()
to the specified value.Set the property corresponding toHwvtepMacTableGenericAttributes.getLogicalSwitchRef()
to the specified value.setMacEntryKey
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toHwvtepMacTableGenericAttributes.getMacEntryKey()
to the specified value.setMacEntryUuid
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value) Set the property corresponding toHwvtepMacTableGenericAttributes.getMacEntryUuid()
to the specified value.Set the key value corresponding toRemoteMcastMacs.key()
to the specified value.
-
Constructor Details
-
RemoteMcastMacsBuilder
public RemoteMcastMacsBuilder()Construct an empty builder. -
RemoteMcastMacsBuilder
Construct a new builder initialized from specifiedHwvtepMacTableGenericAttributes
.- Parameters:
arg
- HwvtepMacTableGenericAttributes from which the builder should be initialized
-
RemoteMcastMacsBuilder
Construct a new builder initialized from specifiedHwvtepMcastMacTableAttributes
.- Parameters:
arg
- HwvtepMcastMacTableAttributes from which the builder should be initialized
-
RemoteMcastMacsBuilder
Construct a new builder initialized from specifiedHwvtepPhysicalLocatorSetAttributes
.- Parameters:
arg
- HwvtepPhysicalLocatorSetAttributes from which the builder should be initialized
-
RemoteMcastMacsBuilder
Construct a builder initialized with state from specifiedRemoteMcastMacs
.- Parameters:
base
- RemoteMcastMacs 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
-
key
Return current value associated with the property corresponding toRemoteMcastMacs.key()
.- Returns:
- current value
-
getIpaddr
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpaddr()Return current value associated with the property corresponding toHwvtepMcastMacTableAttributes.getIpaddr()
.- Returns:
- current value
-
getLocatorSet
Return current value associated with the property corresponding toHwvtepPhysicalLocatorSetAttributes.getLocatorSet()
.- Returns:
- current value
-
getLogicalSwitchRef
Return current value associated with the property corresponding toHwvtepMacTableGenericAttributes.getLogicalSwitchRef()
.- Returns:
- current value
-
getMacEntryKey
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMacEntryKey()Return current value associated with the property corresponding toHwvtepMacTableGenericAttributes.getMacEntryKey()
.- Returns:
- current value
-
getMacEntryUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getMacEntryUuid()Return current value associated with the property corresponding toHwvtepMacTableGenericAttributes.getMacEntryUuid()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoteMcastMacs>> 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
-
withKey
Set the key value corresponding toRemoteMcastMacs.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setIpaddr
public RemoteMcastMacsBuilder setIpaddr(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value) Set the property corresponding toHwvtepMcastMacTableAttributes.getIpaddr()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocatorSet
Set the property corresponding toHwvtepPhysicalLocatorSetAttributes.getLocatorSet()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setLogicalSwitchRef
Set the property corresponding toHwvtepMacTableGenericAttributes.getLogicalSwitchRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMacEntryKey
public RemoteMcastMacsBuilder setMacEntryKey(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value) Set the property corresponding toHwvtepMacTableGenericAttributes.getMacEntryKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMacEntryUuid
public RemoteMcastMacsBuilder setMacEntryUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value) Set the property corresponding toHwvtepMacTableGenericAttributes.getMacEntryUuid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RemoteMcastMacsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RemoteMcastMacs> 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 RemoteMcastMacsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoteMcastMacs>> 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 newRemoteMcastMacs
instance.- Returns:
- A new
RemoteMcastMacs
instance.
-