Class UpdateLspInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.UpdateLspInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<UpdateLspInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<UpdateLspInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class UpdateLspInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<UpdateLspInput>
Class that buildsUpdateLspInput
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:
UpdateLspInput createUpdateLspInput(int fooXyzzy, int barBaz) { return new UpdateLspInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UpdateLspInput, 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:
UpdateLspInput
,Builder
-
-
Constructor Summary
Constructors Constructor Description UpdateLspInputBuilder()
UpdateLspInputBuilder(NetworkTopologyReference arg)
UpdateLspInputBuilder(LspId arg)
UpdateLspInputBuilder(NodeId arg)
UpdateLspInputBuilder(UpdateLspArgs arg)
UpdateLspInputBuilder(UpdateLspInput base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdateLspInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateLspInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateLspInput>>
E$$augmentation(Class<E$$> augmentationType)
UpdateLspInput
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()
UpdateLspInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateLspInput>> augmentationType)
Remove an augmentation from this builder's product.UpdateLspInputBuilder
setArguments(Arguments value)
UpdateLspInputBuilder
setName(String value)
UpdateLspInputBuilder
setNetworkTopologyRef(NetworkTopologyRef value)
UpdateLspInputBuilder
setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
-
-
-
Constructor Detail
-
UpdateLspInputBuilder
public UpdateLspInputBuilder()
-
UpdateLspInputBuilder
public UpdateLspInputBuilder(NetworkTopologyReference arg)
-
UpdateLspInputBuilder
public UpdateLspInputBuilder(UpdateLspArgs arg)
-
UpdateLspInputBuilder
public UpdateLspInputBuilder(LspId arg)
-
UpdateLspInputBuilder
public UpdateLspInputBuilder(NodeId arg)
-
UpdateLspInputBuilder
public UpdateLspInputBuilder(UpdateLspInput 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
- UpdateLspArgs
- 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<UpdateLspInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setArguments
public UpdateLspInputBuilder setArguments(Arguments value)
-
setName
public UpdateLspInputBuilder setName(String value)
-
setNetworkTopologyRef
public UpdateLspInputBuilder setNetworkTopologyRef(NetworkTopologyRef value)
-
setNode
public UpdateLspInputBuilder setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
-
addAugmentation
public UpdateLspInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateLspInput> 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 UpdateLspInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateLspInput>> 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 UpdateLspInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<UpdateLspInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<UpdateLspInput,IllegalArgumentException>
-
-