Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.programming.rev181109
Class SubmitAddLspInputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.programming.rev181109.SubmitAddLspInputBuilder
Class that builds
SubmitAddLspInput
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:
SubmitAddLspInput createSubmitAddLspInput(int fooXyzzy, int barBaz) {
return new SubmitAddLspInputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SubmitAddLspInput, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedNetworkTopologyReference
.Construct a new builder initialized from specifiedSubmitInstructionInput
.Construct a builder initialized with state from specifiedSubmitAddLspInput
.Construct a new builder initialized from specifiedAddLspArgs
.Construct a new builder initialized from specifiedLspId
.Construct a new builder initialized from specifiedNodeId
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<SubmitAddLspInput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<SubmitAddLspInput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull SubmitAddLspInput
build()
A newSubmitAddLspInput
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toAddLspArgs.getArguments()
.Return current value associated with the property corresponding toSubmitInstructionInput.getDeadline()
.getId()
Return current value associated with the property corresponding toSubmitInstructionInput.getId()
.getName()
Return current value associated with the property corresponding toLspId.getName()
.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()
.Return current value associated with the property corresponding toSubmitInstructionInput.getPreconditions()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<SubmitAddLspInput>> augmentationType) Remove an augmentation from this builder's product.setArguments
(Arguments value) Set the property corresponding toAddLspArgs.getArguments()
to the specified value.setDeadline
(Nanotime value) Set the property corresponding toSubmitInstructionInput.getDeadline()
to the specified value.setId
(InstructionId value) Set the property corresponding toSubmitInstructionInput.getId()
to the specified value.Set the property corresponding toLspId.getName()
to the specified value.Set the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
to the specified value.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.setPreconditions
(Set<InstructionId> values) Set the property corresponding toSubmitInstructionInput.getPreconditions()
to the specified value.
-
Constructor Details
-
SubmitAddLspInputBuilder
public SubmitAddLspInputBuilder()Construct an empty builder. -
SubmitAddLspInputBuilder
Construct a new builder initialized from specifiedSubmitInstructionInput
.- Parameters:
arg
- SubmitInstructionInput from which the builder should be initialized
-
SubmitAddLspInputBuilder
Construct a new builder initialized from specifiedNetworkTopologyReference
.- Parameters:
arg
- NetworkTopologyReference from which the builder should be initialized
-
SubmitAddLspInputBuilder
Construct a new builder initialized from specifiedAddLspArgs
.- Parameters:
arg
- AddLspArgs from which the builder should be initialized
-
SubmitAddLspInputBuilder
Construct a new builder initialized from specifiedLspId
.- Parameters:
arg
- LspId from which the builder should be initialized
-
SubmitAddLspInputBuilder
Construct a new builder initialized from specifiedNodeId
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.NodeId from which the builder should be initialized
-
SubmitAddLspInputBuilder
Construct a builder initialized with state from specifiedSubmitAddLspInput
.- Parameters:
base
- SubmitAddLspInput from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
Return current value associated with the property corresponding toAddLspArgs.getArguments()
.- Returns:
- current value
-
getDeadline
Return current value associated with the property corresponding toSubmitInstructionInput.getDeadline()
.- Returns:
- current value
-
getId
Return current value associated with the property corresponding toSubmitInstructionInput.getId()
.- Returns:
- current value
-
getName
Return current value associated with the property corresponding toLspId.getName()
.- Returns:
- current value
-
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
Return current value associated with the property corresponding toSubmitInstructionInput.getPreconditions()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<SubmitAddLspInput>> 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
Set the property corresponding toAddLspArgs.getArguments()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDeadline
Set the property corresponding toSubmitInstructionInput.getDeadline()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setId
Set the property corresponding toSubmitInstructionInput.getId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
Set the property corresponding toLspId.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNetworkTopologyRef
Set the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public SubmitAddLspInputBuilder 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
Set the property corresponding toSubmitInstructionInput.getPreconditions()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public SubmitAddLspInputBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<SubmitAddLspInput> 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 SubmitAddLspInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<SubmitAddLspInput>> 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
A newSubmitAddLspInput
instance.- Returns:
- A new
SubmitAddLspInput
instance.
-