Class ManagerEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.node.attributes.ManagerEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ManagerEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ManagerEntry,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ManagerEntryBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ManagerEntry>
Class that buildsManagerEntryBuilder
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:
ManagerEntryBuilder createTarget(int fooXyzzy, int barBaz) { return new ManagerEntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ManagerEntryBuilder, 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:
ManagerEntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ManagerEntryBuilder()
ManagerEntryBuilder(ManagerEntry base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
ManagerEntry
build()
Boolean
getConnected()
org.opendaylight.yangtools.yang.common.Uint32
getNumberOfConnections()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
getTarget()
Boolean
isConnected()
Deprecated, for removal: This API element is subject to removal in a future version.ManagerEntryKey
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)
ManagerEntryBuilder
setNumberOfConnections(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNumberOfConnections(Uint32)
instead.ManagerEntryBuilder
setNumberOfConnections(org.opendaylight.yangtools.yang.common.Uint32 value)
ManagerEntryBuilder
setTarget(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
ManagerEntryBuilder
withKey(ManagerEntryKey key)
-
-
-
Constructor Detail
-
ManagerEntryBuilder
public ManagerEntryBuilder()
-
ManagerEntryBuilder
public ManagerEntryBuilder(ManagerEntry base)
-
-
Method Detail
-
key
public ManagerEntryKey key()
-
getConnected
public Boolean getConnected()
-
isConnected
@Deprecated(forRemoval=true) public final Boolean isConnected()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getNumberOfConnections
public org.opendaylight.yangtools.yang.common.Uint32 getNumberOfConnections()
-
getTarget
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTarget()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ManagerEntry>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ManagerEntryBuilder withKey(ManagerEntryKey key)
-
setConnected
public ManagerEntryBuilder setConnected(Boolean value)
-
setNumberOfConnections
public ManagerEntryBuilder setNumberOfConnections(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setNumberOfConnections
@Deprecated(forRemoval=true) public ManagerEntryBuilder setNumberOfConnections(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNumberOfConnections(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTarget
public ManagerEntryBuilder setTarget(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
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 ManagerEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ManagerEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ManagerEntry,IllegalArgumentException>
-
-