Class BridgeMemberBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.network.topology.topology.node.BridgeMemberBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BridgeMember>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BridgeMember,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BridgeMemberBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<BridgeMember>
Class that buildsBridgeMemberBuilder
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:
BridgeMemberBuilder createTarget(int fooXyzzy, int barBaz) { return new BridgeMemberBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BridgeMemberBuilder, 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:
BridgeMemberBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BridgeMemberBuilder()
BridgeMemberBuilder(BridgeMember base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BridgeMemberBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BridgeMember> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeMember>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
BridgeMember
build()
ExternalReference
getSupportingBridgeDomain()
BridgeMemberBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeMember>> augmentationType)
Remove an augmentation from this builder's product.BridgeMemberBuilder
setSupportingBridgeDomain(ExternalReference value)
-
-
-
Constructor Detail
-
BridgeMemberBuilder
public BridgeMemberBuilder()
-
BridgeMemberBuilder
public BridgeMemberBuilder(BridgeMember base)
-
-
Method Detail
-
getSupportingBridgeDomain
public ExternalReference getSupportingBridgeDomain()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeMember>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setSupportingBridgeDomain
public BridgeMemberBuilder setSupportingBridgeDomain(ExternalReference value)
-
addAugmentation
public BridgeMemberBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BridgeMember> 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 BridgeMemberBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BridgeMember>> 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 BridgeMember build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BridgeMember>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BridgeMember,java.lang.IllegalArgumentException>
-
-