Class ControllerEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.ovsdb.bridge.attributes.ControllerEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ControllerEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ControllerEntry,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ControllerEntryBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ControllerEntry>
Class that buildsControllerEntryBuilder
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:
ControllerEntryBuilder createTarget(int fooXyzzy, int barBaz) { return new ControllerEntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ControllerEntryBuilder, 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:
ControllerEntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ControllerEntryBuilder()
ControllerEntryBuilder(ControllerEntry base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ControllerEntryBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry>>
E$$augmentation(Class<E$$> augmentationType)
ControllerEntry
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getControllerUuid()
org.opendaylight.yangtools.yang.common.Uint32
getInactivityProbe()
org.opendaylight.yangtools.yang.common.Uint32
getMaxBackoff()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
getTarget()
Boolean
isIsConnected()
ControllerEntryKey
key()
ControllerEntryBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry>> augmentationType)
ControllerEntryBuilder
setControllerUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
ControllerEntryBuilder
setInactivityProbe(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setInactivityProbe(Uint32)} instead.ControllerEntryBuilder
setInactivityProbe(org.opendaylight.yangtools.yang.common.Uint32 value)
ControllerEntryBuilder
setIsConnected(Boolean value)
ControllerEntryBuilder
setMaxBackoff(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxBackoff(Uint32)} instead.ControllerEntryBuilder
setMaxBackoff(org.opendaylight.yangtools.yang.common.Uint32 value)
ControllerEntryBuilder
setTarget(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
ControllerEntryBuilder
withKey(ControllerEntryKey key)
-
-
-
Constructor Detail
-
ControllerEntryBuilder
public ControllerEntryBuilder()
-
ControllerEntryBuilder
public ControllerEntryBuilder(ControllerEntry base)
-
-
Method Detail
-
key
public ControllerEntryKey key()
-
getControllerUuid
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getControllerUuid()
-
getInactivityProbe
public org.opendaylight.yangtools.yang.common.Uint32 getInactivityProbe()
-
getMaxBackoff
public org.opendaylight.yangtools.yang.common.Uint32 getMaxBackoff()
-
getTarget
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTarget()
-
isIsConnected
public Boolean isIsConnected()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ControllerEntryBuilder withKey(ControllerEntryKey key)
-
setControllerUuid
public ControllerEntryBuilder setControllerUuid(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
setInactivityProbe
public ControllerEntryBuilder setInactivityProbe(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setInactivityProbe
@Deprecated(forRemoval=true) public ControllerEntryBuilder setInactivityProbe(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setInactivityProbe(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMaxBackoff
public ControllerEntryBuilder setMaxBackoff(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMaxBackoff
@Deprecated(forRemoval=true) public ControllerEntryBuilder setMaxBackoff(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMaxBackoff(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTarget
public ControllerEntryBuilder setTarget(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
setIsConnected
public ControllerEntryBuilder setIsConnected(Boolean value)
-
addAugmentation
public ControllerEntryBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry> augmentationValue)
-
removeAugmentation
public ControllerEntryBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControllerEntry>> augmentationType)
-
build
public ControllerEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ControllerEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ControllerEntry,IllegalArgumentException>
-
-