Class LogicalSwitchesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitchesBuilder
-
@Generated("mdsal-binding-generator") public class LogicalSwitchesBuilder extends Object
Class that buildsLogicalSwitches
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:
LogicalSwitches createLogicalSwitches(int fooXyzzy, int barBaz) { return new LogicalSwitchesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LogicalSwitches, 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:
LogicalSwitches
- 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 LogicalSwitchesBuilder()
Construct an empty builder.LogicalSwitchesBuilder(LogicalSwitches base)
Construct a builder initialized with state from specifiedLogicalSwitches
.LogicalSwitchesBuilder(HwvtepLogicalSwitchAttributes arg)
Construct a new builder initialized from specifiedHwvtepLogicalSwitchAttributes
.LogicalSwitchesBuilder(HwvtepNodeIdentification arg)
Construct a new builder initialized from specifiedHwvtepNodeIdentification
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LogicalSwitchesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LogicalSwitches> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LogicalSwitches>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LogicalSwitches
build()
A newLogicalSwitches
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getHwvtepNodeDescription()
Return current value associated with the property corresponding toHwvtepNodeIdentification.getHwvtepNodeDescription()
.HwvtepNodeName
getHwvtepNodeName()
Return current value associated with the property corresponding toHwvtepNodeIdentification.getHwvtepNodeName()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getLogicalSwitchUuid()
Return current value associated with the property corresponding toHwvtepLogicalSwitchAttributes.getLogicalSwitchUuid()
.String
getReplicationMode()
Return current value associated with the property corresponding toHwvtepLogicalSwitchAttributes.getReplicationMode()
.String
getTunnelKey()
Return current value associated with the property corresponding toHwvtepLogicalSwitchAttributes.getTunnelKey()
.LogicalSwitchesKey
key()
Return current value associated with the property corresponding toLogicalSwitches.key()
.LogicalSwitchesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LogicalSwitches>> augmentationType)
Remove an augmentation from this builder's product.LogicalSwitchesBuilder
setHwvtepNodeDescription(String value)
Set the property corresponding toHwvtepNodeIdentification.getHwvtepNodeDescription()
to the specified value.LogicalSwitchesBuilder
setHwvtepNodeName(HwvtepNodeName value)
Set the property corresponding toHwvtepNodeIdentification.getHwvtepNodeName()
to the specified value.LogicalSwitchesBuilder
setLogicalSwitchUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
Set the property corresponding toHwvtepLogicalSwitchAttributes.getLogicalSwitchUuid()
to the specified value.LogicalSwitchesBuilder
setReplicationMode(String value)
Set the property corresponding toHwvtepLogicalSwitchAttributes.getReplicationMode()
to the specified value.LogicalSwitchesBuilder
setTunnelKey(String value)
Set the property corresponding toHwvtepLogicalSwitchAttributes.getTunnelKey()
to the specified value.LogicalSwitchesBuilder
withKey(LogicalSwitchesKey key)
-
-
-
Constructor Detail
-
LogicalSwitchesBuilder
public LogicalSwitchesBuilder()
Construct an empty builder.
-
LogicalSwitchesBuilder
public LogicalSwitchesBuilder(HwvtepLogicalSwitchAttributes arg)
Construct a new builder initialized from specifiedHwvtepLogicalSwitchAttributes
.- Parameters:
arg
- HwvtepLogicalSwitchAttributes from which the builder should be initialized
-
LogicalSwitchesBuilder
public LogicalSwitchesBuilder(HwvtepNodeIdentification arg)
Construct a new builder initialized from specifiedHwvtepNodeIdentification
.- Parameters:
arg
- HwvtepNodeIdentification from which the builder should be initialized
-
LogicalSwitchesBuilder
public LogicalSwitchesBuilder(LogicalSwitches base)
Construct a builder initialized with state from specifiedLogicalSwitches
.- Parameters:
base
- LogicalSwitches 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 LogicalSwitchesKey key()
Return current value associated with the property corresponding toLogicalSwitches.key()
.- Returns:
- current value
-
getHwvtepNodeDescription
public String getHwvtepNodeDescription()
Return current value associated with the property corresponding toHwvtepNodeIdentification.getHwvtepNodeDescription()
.- Returns:
- current value
-
getHwvtepNodeName
public HwvtepNodeName getHwvtepNodeName()
Return current value associated with the property corresponding toHwvtepNodeIdentification.getHwvtepNodeName()
.- Returns:
- current value
-
getLogicalSwitchUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getLogicalSwitchUuid()
Return current value associated with the property corresponding toHwvtepLogicalSwitchAttributes.getLogicalSwitchUuid()
.- Returns:
- current value
-
getReplicationMode
public String getReplicationMode()
Return current value associated with the property corresponding toHwvtepLogicalSwitchAttributes.getReplicationMode()
.- Returns:
- current value
-
getTunnelKey
public String getTunnelKey()
Return current value associated with the property corresponding toHwvtepLogicalSwitchAttributes.getTunnelKey()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LogicalSwitches>> 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 LogicalSwitchesBuilder withKey(LogicalSwitchesKey key)
-
setHwvtepNodeDescription
public LogicalSwitchesBuilder setHwvtepNodeDescription(String value)
Set the property corresponding toHwvtepNodeIdentification.getHwvtepNodeDescription()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHwvtepNodeName
public LogicalSwitchesBuilder setHwvtepNodeName(HwvtepNodeName value)
Set the property corresponding toHwvtepNodeIdentification.getHwvtepNodeName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLogicalSwitchUuid
public LogicalSwitchesBuilder setLogicalSwitchUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
Set the property corresponding toHwvtepLogicalSwitchAttributes.getLogicalSwitchUuid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReplicationMode
public LogicalSwitchesBuilder setReplicationMode(String value)
Set the property corresponding toHwvtepLogicalSwitchAttributes.getReplicationMode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTunnelKey
public LogicalSwitchesBuilder setTunnelKey(String value)
Set the property corresponding toHwvtepLogicalSwitchAttributes.getTunnelKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LogicalSwitchesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LogicalSwitches> 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 LogicalSwitchesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LogicalSwitches>> 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 LogicalSwitches build()
A newLogicalSwitches
instance.- Returns:
- A new
LogicalSwitches
instance.
-
-