Class ManagerEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagerEntryBuilder
-
@Generated("mdsal-binding-generator") public class ManagerEntryBuilder extends Object
Class that buildsManagerEntry
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:
ManagerEntry createManagerEntry(int fooXyzzy, int barBaz) { return new ManagerEntryBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ManagerEntry, 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:
ManagerEntry
- 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 ManagerEntryBuilder()
Construct an empty builder.ManagerEntryBuilder(ManagerEntry base)
Construct a builder initialized with state from specifiedManagerEntry
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ManagerEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ManagerEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ManagerEntry>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ManagerEntry
build()
A newManagerEntry
instance.Boolean
getConnected()
Return current value associated with the property corresponding toManagerEntry.getConnected()
.org.opendaylight.yangtools.yang.common.Uint32
getNumberOfConnections()
Return current value associated with the property corresponding toManagerEntry.getNumberOfConnections()
.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 toManagerEntry.getTarget()
.ManagerEntryKey
key()
Return current value associated with the property corresponding toManagerEntry.key()
.ManagerEntryBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ManagerEntry>> augmentationType)
Remove an augmentation from this builder's product.ManagerEntryBuilder
setConnected(Boolean value)
Set the property corresponding toManagerEntry.getConnected()
to the specified value.ManagerEntryBuilder
setNumberOfConnections(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toManagerEntry.getNumberOfConnections()
to the specified value.ManagerEntryBuilder
setTarget(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
Set the property corresponding toManagerEntry.getTarget()
to the specified value.ManagerEntryBuilder
withKey(ManagerEntryKey key)
-
-
-
Constructor Detail
-
ManagerEntryBuilder
public ManagerEntryBuilder()
Construct an empty builder.
-
ManagerEntryBuilder
public ManagerEntryBuilder(ManagerEntry base)
Construct a builder initialized with state from specifiedManagerEntry
.- Parameters:
base
- ManagerEntry from which the builder should be initialized
-
-
Method Detail
-
key
public ManagerEntryKey key()
Return current value associated with the property corresponding toManagerEntry.key()
.- Returns:
- current value
-
getConnected
public Boolean getConnected()
Return current value associated with the property corresponding toManagerEntry.getConnected()
.- Returns:
- current value
-
getNumberOfConnections
public org.opendaylight.yangtools.yang.common.Uint32 getNumberOfConnections()
Return current value associated with the property corresponding toManagerEntry.getNumberOfConnections()
.- 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 toManagerEntry.getTarget()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ManagerEntry>> 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 ManagerEntryBuilder withKey(ManagerEntryKey key)
-
setConnected
public ManagerEntryBuilder setConnected(Boolean value)
Set the property corresponding toManagerEntry.getConnected()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNumberOfConnections
public ManagerEntryBuilder setNumberOfConnections(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toManagerEntry.getNumberOfConnections()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTarget
public ManagerEntryBuilder setTarget(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
Set the property corresponding toManagerEntry.getTarget()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ManagerEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ManagerEntry> 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 ManagerEntryBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ManagerEntry>> 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 ManagerEntry build()
A newManagerEntry
instance.- Returns:
- A new
ManagerEntry
instance.
-
-