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