Class BridgeBasedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.l2.state.attributes.interconnection.BridgeBasedBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BridgeBased>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BridgeBased,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BridgeBasedBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BridgeBased>
Class that buildsBridgeBasedBuilder
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:
BridgeBasedBuilder createTarget(int fooXyzzy, int barBaz) { return new BridgeBasedBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BridgeBasedBuilder, 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:
BridgeBasedBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BridgeBasedBuilder()
BridgeBasedBuilder(BridgeBasedAttributes arg)
BridgeBasedBuilder(BridgeBased base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BridgeBasedBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeBased>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BridgeBased> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeBased>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BridgeBased
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.lang.String
getBridgeDomain()
org.opendaylight.yangtools.yang.common.Uint8
getSplitHorizonGroup()
java.lang.Boolean
isBridgedVirtualInterface()
BridgeBasedBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeBased>> augmentationType)
BridgeBasedBuilder
setBridgeDomain(java.lang.String value)
BridgeBasedBuilder
setBridgedVirtualInterface(java.lang.Boolean value)
BridgeBasedBuilder
setSplitHorizonGroup(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSplitHorizonGroup(Uint8)} instead.BridgeBasedBuilder
setSplitHorizonGroup(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
BridgeBasedBuilder
public BridgeBasedBuilder()
-
BridgeBasedBuilder
public BridgeBasedBuilder(BridgeBasedAttributes arg)
-
BridgeBasedBuilder
public BridgeBasedBuilder(BridgeBased base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.BridgeBasedAttributes
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getBridgeDomain
public java.lang.String getBridgeDomain()
-
getSplitHorizonGroup
public org.opendaylight.yangtools.yang.common.Uint8 getSplitHorizonGroup()
-
isBridgedVirtualInterface
public java.lang.Boolean isBridgedVirtualInterface()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeBased>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setBridgeDomain
public BridgeBasedBuilder setBridgeDomain(java.lang.String value)
-
setSplitHorizonGroup
public BridgeBasedBuilder setSplitHorizonGroup(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setSplitHorizonGroup
@Deprecated(forRemoval=true) public BridgeBasedBuilder setSplitHorizonGroup(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setSplitHorizonGroup(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setBridgedVirtualInterface
public BridgeBasedBuilder setBridgedVirtualInterface(java.lang.Boolean value)
-
addAugmentation
public BridgeBasedBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeBased>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BridgeBased> augmentationValue)
-
removeAugmentation
public BridgeBasedBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeBased>> augmentationType)
-
build
public BridgeBased build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BridgeBased>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BridgeBased,java.lang.IllegalArgumentException>
-
-