Class BridgeEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.bridge._interface.info.BridgeEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BridgeEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BridgeEntry,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BridgeEntryBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BridgeEntry>
Class that buildsBridgeEntryBuilder
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:
BridgeEntryBuilder createTarget(int fooXyzzy, int barBaz) { return new BridgeEntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BridgeEntryBuilder, 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:
BridgeEntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BridgeEntryBuilder()
BridgeEntryBuilder(BridgeEntry base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BridgeEntryBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeEntry>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BridgeEntry> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeEntry>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BridgeEntry
build()
java.util.List<BridgeInterfaceEntry>
getBridgeInterfaceEntry()
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef
getBridgeReference()
org.opendaylight.yangtools.yang.common.Uint64
getDpid()
BridgeEntryKey
key()
BridgeEntryBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeEntry>> augmentationType)
BridgeEntryBuilder
setBridgeInterfaceEntry(java.util.List<BridgeInterfaceEntry> values)
BridgeEntryBuilder
setBridgeReference(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef value)
BridgeEntryBuilder
setDpid(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDpid(Uint64)} instead.BridgeEntryBuilder
setDpid(org.opendaylight.yangtools.yang.common.Uint64 value)
BridgeEntryBuilder
withKey(BridgeEntryKey key)
-
-
-
Constructor Detail
-
BridgeEntryBuilder
public BridgeEntryBuilder()
-
BridgeEntryBuilder
public BridgeEntryBuilder(BridgeEntry base)
-
-
Method Detail
-
key
public BridgeEntryKey key()
-
getBridgeInterfaceEntry
public java.util.List<BridgeInterfaceEntry> getBridgeInterfaceEntry()
-
getBridgeReference
public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef getBridgeReference()
-
getDpid
public org.opendaylight.yangtools.yang.common.Uint64 getDpid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeEntry>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public BridgeEntryBuilder withKey(BridgeEntryKey key)
-
setBridgeInterfaceEntry
public BridgeEntryBuilder setBridgeInterfaceEntry(java.util.List<BridgeInterfaceEntry> values)
-
setBridgeReference
public BridgeEntryBuilder setBridgeReference(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeRef value)
-
setDpid
public BridgeEntryBuilder setDpid(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDpid
@Deprecated(forRemoval=true) public BridgeEntryBuilder setDpid(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDpid(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public BridgeEntryBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeEntry>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BridgeEntry> augmentationValue)
-
removeAugmentation
public BridgeEntryBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeEntry>> augmentationType)
-
build
public BridgeEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BridgeEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BridgeEntry,java.lang.IllegalArgumentException>
-
-