Class OvsBridgeRefEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.ovs.bridge.ref.info.OvsBridgeRefEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OvsBridgeRefEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OvsBridgeRefEntry,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OvsBridgeRefEntryBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<OvsBridgeRefEntry>
Class that buildsOvsBridgeRefEntryBuilder
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:
OvsBridgeRefEntryBuilder createTarget(int fooXyzzy, int barBaz) { return new OvsBridgeRefEntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OvsBridgeRefEntryBuilder, 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:
OvsBridgeRefEntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OvsBridgeRefEntryBuilder()
OvsBridgeRefEntryBuilder(OvsBridgeRefEntry base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OvsBridgeRefEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OvsBridgeRefEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OvsBridgeRefEntry>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
OvsBridgeRefEntry
build()
org.opendaylight.yangtools.yang.common.Uint64
getDpid()
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef
getOvsBridgeReference()
OvsBridgeRefEntryKey
key()
OvsBridgeRefEntryBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OvsBridgeRefEntry>> augmentationType)
Remove an augmentation from this builder's product.OvsBridgeRefEntryBuilder
setDpid(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpid(Uint64)
instead.OvsBridgeRefEntryBuilder
setDpid(org.opendaylight.yangtools.yang.common.Uint64 value)
OvsBridgeRefEntryBuilder
setOvsBridgeReference(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef value)
OvsBridgeRefEntryBuilder
withKey(OvsBridgeRefEntryKey key)
-
-
-
Constructor Detail
-
OvsBridgeRefEntryBuilder
public OvsBridgeRefEntryBuilder()
-
OvsBridgeRefEntryBuilder
public OvsBridgeRefEntryBuilder(OvsBridgeRefEntry base)
-
-
Method Detail
-
key
public OvsBridgeRefEntryKey key()
-
getDpid
public org.opendaylight.yangtools.yang.common.Uint64 getDpid()
-
getOvsBridgeReference
public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef getOvsBridgeReference()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OvsBridgeRefEntry>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public OvsBridgeRefEntryBuilder withKey(OvsBridgeRefEntryKey key)
-
setDpid
public OvsBridgeRefEntryBuilder setDpid(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpid
@Deprecated(forRemoval=true) public OvsBridgeRefEntryBuilder setDpid(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDpid(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setOvsBridgeReference
public OvsBridgeRefEntryBuilder setOvsBridgeReference(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef value)
-
addAugmentation
public OvsBridgeRefEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OvsBridgeRefEntry> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public OvsBridgeRefEntryBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OvsBridgeRefEntry>> 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 OvsBridgeRefEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OvsBridgeRefEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OvsBridgeRefEntry,java.lang.IllegalArgumentException>
-
-