Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.programming.rev181109
Class SubmitUpdateLspInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.programming.rev181109.SubmitUpdateLspInputBuilder
-
@Generated("mdsal-binding-generator") public class SubmitUpdateLspInputBuilder extends Object
Class that buildsSubmitUpdateLspInput
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:
SubmitUpdateLspInput createSubmitUpdateLspInput(int fooXyzzy, int barBaz) { return new SubmitUpdateLspInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SubmitUpdateLspInput, 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:
SubmitUpdateLspInput
- 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
-
-
Constructor Summary
Constructors Constructor Description SubmitUpdateLspInputBuilder()
Construct an empty builder.SubmitUpdateLspInputBuilder(NetworkTopologyReference arg)
Construct a new builder initialized from specifiedNetworkTopologyReference
.SubmitUpdateLspInputBuilder(SubmitInstructionInput arg)
Construct a new builder initialized from specifiedSubmitInstructionInput
.SubmitUpdateLspInputBuilder(SubmitUpdateLspInput base)
Construct a builder initialized with state from specifiedSubmitUpdateLspInput
.SubmitUpdateLspInputBuilder(LspId arg)
Construct a new builder initialized from specifiedLspId
.SubmitUpdateLspInputBuilder(NodeId arg)
Construct a new builder initialized from specifiedNodeId
.SubmitUpdateLspInputBuilder(UpdateLspArgs arg)
Construct a new builder initialized from specifiedUpdateLspArgs
.SubmitUpdateLspInputBuilder(TopologyInstructionInput arg)
Construct a new builder initialized from specifiedTopologyInstructionInput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SubmitUpdateLspInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubmitUpdateLspInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubmitUpdateLspInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SubmitUpdateLspInput
build()
A newSubmitUpdateLspInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Arguments
getArguments()
Return current value associated with the property corresponding toUpdateLspArgs.getArguments()
.Nanotime
getDeadline()
Return current value associated with the property corresponding toSubmitInstructionInput.getDeadline()
.InstructionId
getId()
Return current value associated with the property corresponding toSubmitInstructionInput.getId()
.String
getName()
Return current value associated with the property corresponding toLspId.getName()
.NetworkTopologyRef
getNetworkTopologyRef()
Return current value associated with the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
.org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId
getNode()
Return current value associated with the property corresponding toNodeId.getNode()
.Set<InstructionId>
getPreconditions()
Return current value associated with the property corresponding toSubmitInstructionInput.getPreconditions()
.SubmitUpdateLspInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubmitUpdateLspInput>> augmentationType)
Remove an augmentation from this builder's product.SubmitUpdateLspInputBuilder
setArguments(Arguments value)
Set the property corresponding toUpdateLspArgs.getArguments()
to the specified value.SubmitUpdateLspInputBuilder
setDeadline(Nanotime value)
Set the property corresponding toSubmitInstructionInput.getDeadline()
to the specified value.SubmitUpdateLspInputBuilder
setId(InstructionId value)
Set the property corresponding toSubmitInstructionInput.getId()
to the specified value.SubmitUpdateLspInputBuilder
setName(String value)
Set the property corresponding toLspId.getName()
to the specified value.SubmitUpdateLspInputBuilder
setNetworkTopologyRef(NetworkTopologyRef value)
Set the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
to the specified value.SubmitUpdateLspInputBuilder
setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
Set the property corresponding toNodeId.getNode()
to the specified value.SubmitUpdateLspInputBuilder
setPreconditions(Set<InstructionId> values)
Set the property corresponding toSubmitInstructionInput.getPreconditions()
to the specified value.
-
-
-
Constructor Detail
-
SubmitUpdateLspInputBuilder
public SubmitUpdateLspInputBuilder()
Construct an empty builder.
-
SubmitUpdateLspInputBuilder
public SubmitUpdateLspInputBuilder(TopologyInstructionInput arg)
Construct a new builder initialized from specifiedTopologyInstructionInput
.- Parameters:
arg
- TopologyInstructionInput from which the builder should be initialized
-
SubmitUpdateLspInputBuilder
public SubmitUpdateLspInputBuilder(SubmitInstructionInput arg)
Construct a new builder initialized from specifiedSubmitInstructionInput
.- Parameters:
arg
- SubmitInstructionInput from which the builder should be initialized
-
SubmitUpdateLspInputBuilder
public SubmitUpdateLspInputBuilder(NetworkTopologyReference arg)
Construct a new builder initialized from specifiedNetworkTopologyReference
.- Parameters:
arg
- NetworkTopologyReference from which the builder should be initialized
-
SubmitUpdateLspInputBuilder
public SubmitUpdateLspInputBuilder(UpdateLspArgs arg)
Construct a new builder initialized from specifiedUpdateLspArgs
.- Parameters:
arg
- UpdateLspArgs from which the builder should be initialized
-
SubmitUpdateLspInputBuilder
public SubmitUpdateLspInputBuilder(LspId arg)
Construct a new builder initialized from specifiedLspId
.- Parameters:
arg
- LspId from which the builder should be initialized
-
SubmitUpdateLspInputBuilder
public SubmitUpdateLspInputBuilder(NodeId arg)
Construct a new builder initialized from specifiedNodeId
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev200120.NodeId from which the builder should be initialized
-
SubmitUpdateLspInputBuilder
public SubmitUpdateLspInputBuilder(SubmitUpdateLspInput base)
Construct a builder initialized with state from specifiedSubmitUpdateLspInput
.- Parameters:
base
- SubmitUpdateLspInput from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getArguments
public Arguments getArguments()
Return current value associated with the property corresponding toUpdateLspArgs.getArguments()
.- Returns:
- current value
-
getDeadline
public Nanotime getDeadline()
Return current value associated with the property corresponding toSubmitInstructionInput.getDeadline()
.- Returns:
- current value
-
getId
public InstructionId getId()
Return current value associated with the property corresponding toSubmitInstructionInput.getId()
.- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toLspId.getName()
.- Returns:
- current value
-
getNetworkTopologyRef
public NetworkTopologyRef getNetworkTopologyRef()
Return current value associated with the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
.- Returns:
- current value
-
getNode
public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId getNode()
Return current value associated with the property corresponding toNodeId.getNode()
.- Returns:
- current value
-
getPreconditions
public Set<InstructionId> getPreconditions()
Return current value associated with the property corresponding toSubmitInstructionInput.getPreconditions()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubmitUpdateLspInput>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setArguments
public SubmitUpdateLspInputBuilder setArguments(Arguments value)
Set the property corresponding toUpdateLspArgs.getArguments()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDeadline
public SubmitUpdateLspInputBuilder setDeadline(Nanotime value)
Set the property corresponding toSubmitInstructionInput.getDeadline()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setId
public SubmitUpdateLspInputBuilder setId(InstructionId value)
Set the property corresponding toSubmitInstructionInput.getId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
public SubmitUpdateLspInputBuilder setName(String value)
Set the property corresponding toLspId.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNetworkTopologyRef
public SubmitUpdateLspInputBuilder setNetworkTopologyRef(NetworkTopologyRef value)
Set the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public SubmitUpdateLspInputBuilder setNode(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
Set the property corresponding toNodeId.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPreconditions
public SubmitUpdateLspInputBuilder setPreconditions(Set<InstructionId> values)
Set the property corresponding toSubmitInstructionInput.getPreconditions()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public SubmitUpdateLspInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SubmitUpdateLspInput> 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 SubmitUpdateLspInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubmitUpdateLspInput>> 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 @NonNull SubmitUpdateLspInput build()
A newSubmitUpdateLspInput
instance.- Returns:
- A new
SubmitUpdateLspInput
instance.
-
-