Class ControllerEntryBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntryBuilder
Class that builds
ControllerEntry
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:
ControllerEntry createControllerEntry(int fooXyzzy, int barBaz) {
return new ControllerEntryBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ControllerEntry, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedControllerEntry
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ControllerEntry
build()
A newControllerEntry
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
Return current value associated with the property corresponding toControllerEntry.getControllerUuid()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toControllerEntry.getInactivityProbe()
.Return current value associated with the property corresponding toControllerEntry.getIsConnected()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toControllerEntry.getMaxBackoff()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
Return current value associated with the property corresponding toControllerEntry.getTarget()
.key()
Return current value associated with the property corresponding toControllerEntry.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry>> augmentationType) Remove an augmentation from this builder's product.setControllerUuid
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value) Set the property corresponding toControllerEntry.getControllerUuid()
to the specified value.setInactivityProbe
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toControllerEntry.getInactivityProbe()
to the specified value.setIsConnected
(Boolean value) Set the property corresponding toControllerEntry.getIsConnected()
to the specified value.setMaxBackoff
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toControllerEntry.getMaxBackoff()
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 toControllerEntry.getTarget()
to the specified value.Set the key value corresponding toControllerEntry.key()
to the specified value.
-
Constructor Details
-
ControllerEntryBuilder
public ControllerEntryBuilder()Construct an empty builder. -
ControllerEntryBuilder
Construct a builder initialized with state from specifiedControllerEntry
.- Parameters:
base
- ControllerEntry from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toControllerEntry.key()
.- Returns:
- current value
-
getControllerUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getControllerUuid()Return current value associated with the property corresponding toControllerEntry.getControllerUuid()
.- Returns:
- current value
-
getInactivityProbe
public org.opendaylight.yangtools.yang.common.Uint32 getInactivityProbe()Return current value associated with the property corresponding toControllerEntry.getInactivityProbe()
.- Returns:
- current value
-
getIsConnected
Return current value associated with the property corresponding toControllerEntry.getIsConnected()
.- Returns:
- current value
-
getMaxBackoff
public org.opendaylight.yangtools.yang.common.Uint32 getMaxBackoff()Return current value associated with the property corresponding toControllerEntry.getMaxBackoff()
.- 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 toControllerEntry.getTarget()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry>> 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 toControllerEntry.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setControllerUuid
public ControllerEntryBuilder setControllerUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value) Set the property corresponding toControllerEntry.getControllerUuid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInactivityProbe
public ControllerEntryBuilder setInactivityProbe(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toControllerEntry.getInactivityProbe()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIsConnected
Set the property corresponding toControllerEntry.getIsConnected()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxBackoff
Set the property corresponding toControllerEntry.getMaxBackoff()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTarget
public ControllerEntryBuilder setTarget(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value) Set the property corresponding toControllerEntry.getTarget()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ControllerEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry> 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 ControllerEntryBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry>> 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 newControllerEntry
instance.- Returns:
- A new
ControllerEntry
instance.
-