Class TearDownSessionInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.TearDownSessionInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TearDownSessionInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TearDownSessionInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TearDownSessionInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<TearDownSessionInput>
Class that buildsTearDownSessionInput
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:
TearDownSessionInput createTearDownSessionInput(int fooXyzzy, int barBaz) { return new TearDownSessionInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TearDownSessionInput, 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 opportunities, 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:
TearDownSessionInput
,Builder
-
-
Constructor Summary
Constructors Constructor Description TearDownSessionInputBuilder()
TearDownSessionInputBuilder(NetworkTopologyReference arg)
TearDownSessionInputBuilder(NodeId arg)
TearDownSessionInputBuilder(TearDownSessionInput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TearDownSessionInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TearDownSessionInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TearDownSessionInput>>
E$$augmentation(Class<E$$> augmentationType)
TearDownSessionInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NetworkTopologyRef
getNetworkTopologyRef()
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId
getNode()
TearDownSessionInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TearDownSessionInput>> augmentationType)
Remove an augmentation from this builder's product.TearDownSessionInputBuilder
setNetworkTopologyRef(NetworkTopologyRef value)
TearDownSessionInputBuilder
setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
-
-
-
Constructor Detail
-
TearDownSessionInputBuilder
public TearDownSessionInputBuilder()
-
TearDownSessionInputBuilder
public TearDownSessionInputBuilder(NetworkTopologyReference arg)
-
TearDownSessionInputBuilder
public TearDownSessionInputBuilder(NodeId arg)
-
TearDownSessionInputBuilder
public TearDownSessionInputBuilder(TearDownSessionInput 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.topology.pcep.rev200120.NodeId
- NetworkTopologyReference
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getNetworkTopologyRef
public NetworkTopologyRef getNetworkTopologyRef()
-
getNode
public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId getNode()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TearDownSessionInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setNetworkTopologyRef
public TearDownSessionInputBuilder setNetworkTopologyRef(NetworkTopologyRef value)
-
setNode
public TearDownSessionInputBuilder setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
-
addAugmentation
public TearDownSessionInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TearDownSessionInput> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public TearDownSessionInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TearDownSessionInput>> 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 TearDownSessionInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TearDownSessionInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TearDownSessionInput,IllegalArgumentException>
-
-