Class LocalArpSourcesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LocalArpSourcesBuilder
-
@Generated("mdsal-binding-generator") public class LocalArpSourcesBuilder extends Object
Class that buildsLocalArpSources
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:
LocalArpSources createLocalArpSources(int fooXyzzy, int barBaz) { return new LocalArpSourcesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LocalArpSources, 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:
LocalArpSources
- 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
-
-
Constructor Summary
Constructors Constructor Description LocalArpSourcesBuilder()
Construct an empty builder.LocalArpSourcesBuilder(LocalArpSources base)
Construct a builder initialized with state from specifiedLocalArpSources
.LocalArpSourcesBuilder(HwvtepArpSourcesAttributes arg)
Construct a new builder initialized from specifiedHwvtepArpSourcesAttributes
.LocalArpSourcesBuilder(HwvtepPhysicalLocatorAttributes arg)
Construct a new builder initialized from specifiedHwvtepPhysicalLocatorAttributes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LocalArpSourcesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LocalArpSources> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalArpSources>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LocalArpSources
build()
A newLocalArpSources
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.Uuid
getArpSourcesUuid()
Return current value associated with the property corresponding toHwvtepArpSourcesAttributes.getArpSourcesUuid()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getDstIp()
Return current value associated with the property corresponding toHwvtepPhysicalLocatorAttributes.getDstIp()
.Class<? extends EncapsulationTypeBase>
getEncapsulationType()
Return current value associated with the property corresponding toHwvtepPhysicalLocatorAttributes.getEncapsulationType()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getPhysicalLocatorUuid()
Return current value associated with the property corresponding toHwvtepPhysicalLocatorAttributes.getPhysicalLocatorUuid()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getSrcMac()
Return current value associated with the property corresponding toHwvtepArpSourcesAttributes.getSrcMac()
.LocalArpSourcesKey
key()
Return current value associated with the property corresponding toLocalArpSources.key()
.LocalArpSourcesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalArpSources>> augmentationType)
Remove an augmentation from this builder's product.LocalArpSourcesBuilder
setArpSourcesUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
Set the property corresponding toHwvtepArpSourcesAttributes.getArpSourcesUuid()
to the specified value.LocalArpSourcesBuilder
setDstIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
Set the property corresponding toHwvtepPhysicalLocatorAttributes.getDstIp()
to the specified value.LocalArpSourcesBuilder
setEncapsulationType(Class<? extends EncapsulationTypeBase> value)
Set the property corresponding toHwvtepPhysicalLocatorAttributes.getEncapsulationType()
to the specified value.LocalArpSourcesBuilder
setPhysicalLocatorUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
Set the property corresponding toHwvtepPhysicalLocatorAttributes.getPhysicalLocatorUuid()
to the specified value.LocalArpSourcesBuilder
setSrcMac(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
Set the property corresponding toHwvtepArpSourcesAttributes.getSrcMac()
to the specified value.LocalArpSourcesBuilder
withKey(LocalArpSourcesKey key)
-
-
-
Constructor Detail
-
LocalArpSourcesBuilder
public LocalArpSourcesBuilder()
Construct an empty builder.
-
LocalArpSourcesBuilder
public LocalArpSourcesBuilder(HwvtepArpSourcesAttributes arg)
Construct a new builder initialized from specifiedHwvtepArpSourcesAttributes
.- Parameters:
arg
- HwvtepArpSourcesAttributes from which the builder should be initialized
-
LocalArpSourcesBuilder
public LocalArpSourcesBuilder(HwvtepPhysicalLocatorAttributes arg)
Construct a new builder initialized from specifiedHwvtepPhysicalLocatorAttributes
.- Parameters:
arg
- HwvtepPhysicalLocatorAttributes from which the builder should be initialized
-
LocalArpSourcesBuilder
public LocalArpSourcesBuilder(LocalArpSources base)
Construct a builder initialized with state from specifiedLocalArpSources
.- Parameters:
base
- LocalArpSources from which the builder should be initialized
-
-
Method Detail
-
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
public LocalArpSourcesKey key()
Return current value associated with the property corresponding toLocalArpSources.key()
.- Returns:
- current value
-
getArpSourcesUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getArpSourcesUuid()
Return current value associated with the property corresponding toHwvtepArpSourcesAttributes.getArpSourcesUuid()
.- Returns:
- current value
-
getDstIp
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getDstIp()
Return current value associated with the property corresponding toHwvtepPhysicalLocatorAttributes.getDstIp()
.- Returns:
- current value
-
getEncapsulationType
public Class<? extends EncapsulationTypeBase> getEncapsulationType()
Return current value associated with the property corresponding toHwvtepPhysicalLocatorAttributes.getEncapsulationType()
.- Returns:
- current value
-
getPhysicalLocatorUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getPhysicalLocatorUuid()
Return current value associated with the property corresponding toHwvtepPhysicalLocatorAttributes.getPhysicalLocatorUuid()
.- Returns:
- current value
-
getSrcMac
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getSrcMac()
Return current value associated with the property corresponding toHwvtepArpSourcesAttributes.getSrcMac()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalArpSources>> 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
public LocalArpSourcesBuilder withKey(LocalArpSourcesKey key)
-
setArpSourcesUuid
public LocalArpSourcesBuilder setArpSourcesUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
Set the property corresponding toHwvtepArpSourcesAttributes.getArpSourcesUuid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDstIp
public LocalArpSourcesBuilder setDstIp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
Set the property corresponding toHwvtepPhysicalLocatorAttributes.getDstIp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEncapsulationType
public LocalArpSourcesBuilder setEncapsulationType(Class<? extends EncapsulationTypeBase> value)
Set the property corresponding toHwvtepPhysicalLocatorAttributes.getEncapsulationType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPhysicalLocatorUuid
public LocalArpSourcesBuilder setPhysicalLocatorUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
Set the property corresponding toHwvtepPhysicalLocatorAttributes.getPhysicalLocatorUuid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSrcMac
public LocalArpSourcesBuilder setSrcMac(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
Set the property corresponding toHwvtepArpSourcesAttributes.getSrcMac()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LocalArpSourcesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LocalArpSources> 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 LocalArpSourcesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalArpSources>> 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
public @NonNull LocalArpSources build()
A newLocalArpSources
instance.- Returns:
- A new
LocalArpSources
instance.
-
-