Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.bridge.domains.state
Class BridgeDomainBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.bridge.domains.state.BridgeDomainBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BridgeDomain>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BridgeDomain,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BridgeDomainBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BridgeDomain>
Class that buildsBridgeDomainBuilder
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:
BridgeDomainBuilder createTarget(int fooXyzzy, int barBaz) { return new BridgeDomainBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BridgeDomainBuilder, 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:
BridgeDomainBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BridgeDomainBuilder()
BridgeDomainBuilder(BridgeDomain base)
BridgeDomainBuilder(BridgeDomainAttributes arg)
BridgeDomainBuilder(L2FibAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BridgeDomainBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BridgeDomain> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeDomain>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BridgeDomain
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.lang.Boolean
getArpTermination()
ArpTerminationTable
getArpTerminationTable()
java.lang.Boolean
getFlood()
java.lang.Boolean
getForward()
L2FibTable
getL2FibTable()
java.lang.Boolean
getLearn()
java.lang.String
getName()
java.lang.Boolean
getUnknownUnicastFlood()
java.lang.Boolean
isArpTermination()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isFlood()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isForward()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isLearn()
Deprecated, for removal: This API element is subject to removal in a future version.java.lang.Boolean
isUnknownUnicastFlood()
Deprecated, for removal: This API element is subject to removal in a future version.BridgeDomainKey
key()
BridgeDomainBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeDomain>> augmentationType)
Remove an augmentation from this builder's product.BridgeDomainBuilder
setArpTermination(java.lang.Boolean value)
BridgeDomainBuilder
setArpTerminationTable(ArpTerminationTable value)
BridgeDomainBuilder
setFlood(java.lang.Boolean value)
BridgeDomainBuilder
setForward(java.lang.Boolean value)
BridgeDomainBuilder
setL2FibTable(L2FibTable value)
BridgeDomainBuilder
setLearn(java.lang.Boolean value)
BridgeDomainBuilder
setName(java.lang.String value)
BridgeDomainBuilder
setUnknownUnicastFlood(java.lang.Boolean value)
BridgeDomainBuilder
withKey(BridgeDomainKey key)
-
-
-
Constructor Detail
-
BridgeDomainBuilder
public BridgeDomainBuilder()
-
BridgeDomainBuilder
public BridgeDomainBuilder(BridgeDomainAttributes arg)
-
BridgeDomainBuilder
public BridgeDomainBuilder(L2FibAttributes arg)
-
BridgeDomainBuilder
public BridgeDomainBuilder(BridgeDomain 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.BridgeDomainAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.L2FibAttributes
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public BridgeDomainKey key()
-
getArpTermination
public java.lang.Boolean getArpTermination()
-
isArpTermination
@Deprecated(forRemoval=true) public final java.lang.Boolean isArpTermination()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getArpTerminationTable
public ArpTerminationTable getArpTerminationTable()
-
getFlood
public java.lang.Boolean getFlood()
-
isFlood
@Deprecated(forRemoval=true) public final java.lang.Boolean isFlood()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getForward
public java.lang.Boolean getForward()
-
isForward
@Deprecated(forRemoval=true) public final java.lang.Boolean isForward()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getL2FibTable
public L2FibTable getL2FibTable()
-
getLearn
public java.lang.Boolean getLearn()
-
isLearn
@Deprecated(forRemoval=true) public final java.lang.Boolean isLearn()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getName
public java.lang.String getName()
-
getUnknownUnicastFlood
public java.lang.Boolean getUnknownUnicastFlood()
-
isUnknownUnicastFlood
@Deprecated(forRemoval=true) public final java.lang.Boolean isUnknownUnicastFlood()
Deprecated, for removal: This API element is subject to removal in a future version.
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeDomain>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public BridgeDomainBuilder withKey(BridgeDomainKey key)
-
setArpTermination
public BridgeDomainBuilder setArpTermination(java.lang.Boolean value)
-
setArpTerminationTable
public BridgeDomainBuilder setArpTerminationTable(ArpTerminationTable value)
-
setFlood
public BridgeDomainBuilder setFlood(java.lang.Boolean value)
-
setForward
public BridgeDomainBuilder setForward(java.lang.Boolean value)
-
setL2FibTable
public BridgeDomainBuilder setL2FibTable(L2FibTable value)
-
setLearn
public BridgeDomainBuilder setLearn(java.lang.Boolean value)
-
setName
public BridgeDomainBuilder setName(java.lang.String value)
-
setUnknownUnicastFlood
public BridgeDomainBuilder setUnknownUnicastFlood(java.lang.Boolean value)
-
addAugmentation
public BridgeDomainBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BridgeDomain> 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 BridgeDomainBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeDomain>> 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 BridgeDomain build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BridgeDomain>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BridgeDomain,java.lang.IllegalArgumentException>
-
-