Class AutoattachBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.AutoattachBuilder
Class that builds
Autoattach
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:
Autoattach createAutoattach(int fooXyzzy, int barBaz) {
return new AutoattachBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Autoattach, 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.AutoattachBuilder
(Autoattach base) Construct a builder initialized with state from specifiedAutoattach
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Autoattach> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Autoattach>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Autoattach
build()
A newAutoattach
instance.Return current value associated with the property corresponding toAutoattach.getAutoattachExternalIds()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
Return current value associated with the property corresponding toAutoattach.getAutoattachId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
Return current value associated with the property corresponding toAutoattach.getAutoattachUuid()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
Return current value associated with the property corresponding toAutoattach.getBridgeId()
.Return current value associated with the property corresponding toAutoattach.getMappings()
.Return current value associated with the property corresponding toAutoattach.getSystemDescription()
.Return current value associated with the property corresponding toAutoattach.getSystemName()
.key()
Return current value associated with the property corresponding toAutoattach.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Autoattach>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toAutoattach.getAutoattachExternalIds()
to the specified value.setAutoattachId
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value) Set the property corresponding toAutoattach.getAutoattachId()
to the specified value.setAutoattachUuid
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value) Set the property corresponding toAutoattach.getAutoattachUuid()
to the specified value.setBridgeId
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value) Set the property corresponding toAutoattach.getBridgeId()
to the specified value.setMappings
(Map<MappingsKey, Mappings> values) Set the property corresponding toAutoattach.getMappings()
to the specified value.setSystemDescription
(String value) Set the property corresponding toAutoattach.getSystemDescription()
to the specified value.setSystemName
(String value) Set the property corresponding toAutoattach.getSystemName()
to the specified value.withKey
(AutoattachKey key) Set the key value corresponding toAutoattach.key()
to the specified value.
-
Constructor Details
-
AutoattachBuilder
public AutoattachBuilder()Construct an empty builder. -
AutoattachBuilder
Construct a builder initialized with state from specifiedAutoattach
.- Parameters:
base
- Autoattach from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toAutoattach.key()
.- Returns:
- current value
-
getAutoattachExternalIds
Return current value associated with the property corresponding toAutoattach.getAutoattachExternalIds()
.- Returns:
- current value
-
getAutoattachId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getAutoattachId()Return current value associated with the property corresponding toAutoattach.getAutoattachId()
.- Returns:
- current value
-
getAutoattachUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getAutoattachUuid()Return current value associated with the property corresponding toAutoattach.getAutoattachUuid()
.- Returns:
- current value
-
getBridgeId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getBridgeId()Return current value associated with the property corresponding toAutoattach.getBridgeId()
.- Returns:
- current value
-
getMappings
Return current value associated with the property corresponding toAutoattach.getMappings()
.- Returns:
- current value
-
getSystemDescription
Return current value associated with the property corresponding toAutoattach.getSystemDescription()
.- Returns:
- current value
-
getSystemName
Return current value associated with the property corresponding toAutoattach.getSystemName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Autoattach>> 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 toAutoattach.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setAutoattachExternalIds
public AutoattachBuilder setAutoattachExternalIds(Map<AutoattachExternalIdsKey, AutoattachExternalIds> values) Set the property corresponding toAutoattach.getAutoattachExternalIds()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setAutoattachId
public AutoattachBuilder setAutoattachId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value) Set the property corresponding toAutoattach.getAutoattachId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAutoattachUuid
public AutoattachBuilder setAutoattachUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value) Set the property corresponding toAutoattach.getAutoattachUuid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBridgeId
public AutoattachBuilder setBridgeId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value) Set the property corresponding toAutoattach.getBridgeId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMappings
Set the property corresponding toAutoattach.getMappings()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setSystemDescription
Set the property corresponding toAutoattach.getSystemDescription()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSystemName
Set the property corresponding toAutoattach.getSystemName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AutoattachBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Autoattach> 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 AutoattachBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Autoattach>> 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 newAutoattach
instance.- Returns:
- A new
Autoattach
instance.
-