Class LogicalSwitchesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.LogicalSwitchesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<LogicalSwitches>
,org.opendaylight.yangtools.concepts.CheckedBuilder<LogicalSwitches,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class LogicalSwitchesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<LogicalSwitches>
Class that buildsLogicalSwitchesBuilder
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:
LogicalSwitchesBuilder createTarget(int fooXyzzy, int barBaz) { return new LogicalSwitchesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LogicalSwitchesBuilder, 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 oportunities, 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:
LogicalSwitchesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description LogicalSwitchesBuilder()
LogicalSwitchesBuilder(LogicalSwitches base)
LogicalSwitchesBuilder(HwvtepLogicalSwitchAttributes arg)
LogicalSwitchesBuilder(HwvtepNodeIdentification arg)
-
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)
LogicalSwitches
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getHwvtepNodeDescription()
HwvtepNodeName
getHwvtepNodeName()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getLogicalSwitchUuid()
String
getReplicationMode()
String
getTunnelKey()
LogicalSwitchesKey
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)
LogicalSwitchesBuilder
setHwvtepNodeName(HwvtepNodeName value)
LogicalSwitchesBuilder
setLogicalSwitchUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
LogicalSwitchesBuilder
setReplicationMode(String value)
LogicalSwitchesBuilder
setTunnelKey(String value)
LogicalSwitchesBuilder
withKey(LogicalSwitchesKey key)
-
-
-
Constructor Detail
-
LogicalSwitchesBuilder
public LogicalSwitchesBuilder()
-
LogicalSwitchesBuilder
public LogicalSwitchesBuilder(HwvtepLogicalSwitchAttributes arg)
-
LogicalSwitchesBuilder
public LogicalSwitchesBuilder(HwvtepNodeIdentification arg)
-
LogicalSwitchesBuilder
public LogicalSwitchesBuilder(LogicalSwitches base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepLogicalSwitchAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.HwvtepNodeIdentification
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public LogicalSwitchesKey key()
-
getHwvtepNodeDescription
public String getHwvtepNodeDescription()
-
getHwvtepNodeName
public HwvtepNodeName getHwvtepNodeName()
-
getLogicalSwitchUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getLogicalSwitchUuid()
-
getReplicationMode
public String getReplicationMode()
-
getTunnelKey
public String getTunnelKey()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LogicalSwitches>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public LogicalSwitchesBuilder withKey(LogicalSwitchesKey key)
-
setHwvtepNodeDescription
public LogicalSwitchesBuilder setHwvtepNodeDescription(String value)
-
setHwvtepNodeName
public LogicalSwitchesBuilder setHwvtepNodeName(HwvtepNodeName value)
-
setLogicalSwitchUuid
public LogicalSwitchesBuilder setLogicalSwitchUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setReplicationMode
public LogicalSwitchesBuilder setReplicationMode(String value)
-
setTunnelKey
public LogicalSwitchesBuilder setTunnelKey(String value)
-
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 LogicalSwitches build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<LogicalSwitches>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<LogicalSwitches,IllegalArgumentException>
-
-