Class ManagersBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.hwvtep.rev150901.hwvtep.global.attributes.ManagersBuilder
Class that builds
Managers
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:
Managers createManagers(int fooXyzzy, int barBaz) {
return new ManagersBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Managers, 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.ManagersBuilder
(Managers base) Construct a builder initialized with state from specifiedManagers
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Managers> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Managers>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Managers
build()
A newManagers
instance.Return current value associated with the property corresponding toManagers.getIsConnected()
.Return current value associated with the property corresponding toManagers.getManagerOtherConfigs()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
Return current value associated with the property corresponding toManagers.getManagerUuid()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
Return current value associated with the property corresponding toManagers.getTarget()
.key()
Return current value associated with the property corresponding toManagers.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Managers>> augmentationType) Remove an augmentation from this builder's product.setIsConnected
(Boolean value) Set the property corresponding toManagers.getIsConnected()
to the specified value.Set the property corresponding toManagers.getManagerOtherConfigs()
to the specified value.setManagerUuid
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value) Set the property corresponding toManagers.getManagerUuid()
to the specified value.setTarget
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value) Set the property corresponding toManagers.getTarget()
to the specified value.withKey
(ManagersKey key) Set the key value corresponding toManagers.key()
to the specified value.
-
Constructor Details
-
ManagersBuilder
public ManagersBuilder()Construct an empty builder. -
ManagersBuilder
Construct a builder initialized with state from specifiedManagers
.- Parameters:
base
- Managers from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toManagers.key()
.- Returns:
- current value
-
getIsConnected
Return current value associated with the property corresponding toManagers.getIsConnected()
.- Returns:
- current value
-
getManagerOtherConfigs
Return current value associated with the property corresponding toManagers.getManagerOtherConfigs()
.- Returns:
- current value
-
getManagerUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getManagerUuid()Return current value associated with the property corresponding toManagers.getManagerUuid()
.- Returns:
- current value
-
getTarget
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTarget()Return current value associated with the property corresponding toManagers.getTarget()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Managers>> 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 toManagers.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setIsConnected
Set the property corresponding toManagers.getIsConnected()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setManagerOtherConfigs
public ManagersBuilder setManagerOtherConfigs(Map<ManagerOtherConfigsKey, ManagerOtherConfigs> values) Set the property corresponding toManagers.getManagerOtherConfigs()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setManagerUuid
public ManagersBuilder setManagerUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value) Set the property corresponding toManagers.getManagerUuid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTarget
public ManagersBuilder setTarget(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value) Set the property corresponding toManagers.getTarget()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ManagersBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Managers> 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 ManagersBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Managers>> 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 newManagers
instance.- Returns:
- A new
Managers
instance.
-