Class PcepDestroyTunnelInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev181109.PcepDestroyTunnelInputBuilder
-
@Generated("mdsal-binding-generator") public class PcepDestroyTunnelInputBuilder extends Object
Class that buildsPcepDestroyTunnelInput
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:
PcepDestroyTunnelInput createPcepDestroyTunnelInput(int fooXyzzy, int barBaz) { return new PcepDestroyTunnelInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PcepDestroyTunnelInput, 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:
PcepDestroyTunnelInput
- 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 PcepDestroyTunnelInputBuilder()
Construct an empty builder.PcepDestroyTunnelInputBuilder(NetworkTopologyReference arg)
Construct a new builder initialized from specifiedNetworkTopologyReference
.PcepDestroyTunnelInputBuilder(SubmitInstructionInput arg)
Construct a new builder initialized from specifiedSubmitInstructionInput
.PcepDestroyTunnelInputBuilder(TopologyInstructionInput arg)
Construct a new builder initialized from specifiedTopologyInstructionInput
.PcepDestroyTunnelInputBuilder(PcepDestroyTunnelInput base)
Construct a builder initialized with state from specifiedPcepDestroyTunnelInput
.PcepDestroyTunnelInputBuilder(BaseTunnelInput arg)
Construct a new builder initialized from specifiedBaseTunnelInput
.PcepDestroyTunnelInputBuilder(DestroyTunnelInput arg)
Construct a new builder initialized from specifiedDestroyTunnelInput
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PcepDestroyTunnelInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepDestroyTunnelInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepDestroyTunnelInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PcepDestroyTunnelInput
build()
A newPcepDestroyTunnelInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Nanotime
getDeadline()
Return current value associated with the property corresponding toSubmitInstructionInput.getDeadline()
.InstructionId
getId()
Return current value associated with the property corresponding toSubmitInstructionInput.getId()
.org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId
getLinkId()
Return current value associated with the property corresponding toBaseTunnelInput.getLinkId()
.NetworkTopologyRef
getNetworkTopologyRef()
Return current value associated with the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
.Set<InstructionId>
getPreconditions()
Return current value associated with the property corresponding toSubmitInstructionInput.getPreconditions()
.PcepDestroyTunnelInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepDestroyTunnelInput>> augmentationType)
Remove an augmentation from this builder's product.PcepDestroyTunnelInputBuilder
setDeadline(Nanotime value)
Set the property corresponding toSubmitInstructionInput.getDeadline()
to the specified value.PcepDestroyTunnelInputBuilder
setId(InstructionId value)
Set the property corresponding toSubmitInstructionInput.getId()
to the specified value.PcepDestroyTunnelInputBuilder
setLinkId(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value)
Set the property corresponding toBaseTunnelInput.getLinkId()
to the specified value.PcepDestroyTunnelInputBuilder
setNetworkTopologyRef(NetworkTopologyRef value)
Set the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
to the specified value.PcepDestroyTunnelInputBuilder
setPreconditions(Set<InstructionId> values)
Set the property corresponding toSubmitInstructionInput.getPreconditions()
to the specified value.
-
-
-
Constructor Detail
-
PcepDestroyTunnelInputBuilder
public PcepDestroyTunnelInputBuilder()
Construct an empty builder.
-
PcepDestroyTunnelInputBuilder
public PcepDestroyTunnelInputBuilder(DestroyTunnelInput arg)
Construct a new builder initialized from specifiedDestroyTunnelInput
.- Parameters:
arg
- DestroyTunnelInput from which the builder should be initialized
-
PcepDestroyTunnelInputBuilder
public PcepDestroyTunnelInputBuilder(BaseTunnelInput arg)
Construct a new builder initialized from specifiedBaseTunnelInput
.- Parameters:
arg
- BaseTunnelInput from which the builder should be initialized
-
PcepDestroyTunnelInputBuilder
public PcepDestroyTunnelInputBuilder(TopologyInstructionInput arg)
Construct a new builder initialized from specifiedTopologyInstructionInput
.- Parameters:
arg
- TopologyInstructionInput from which the builder should be initialized
-
PcepDestroyTunnelInputBuilder
public PcepDestroyTunnelInputBuilder(SubmitInstructionInput arg)
Construct a new builder initialized from specifiedSubmitInstructionInput
.- Parameters:
arg
- SubmitInstructionInput from which the builder should be initialized
-
PcepDestroyTunnelInputBuilder
public PcepDestroyTunnelInputBuilder(NetworkTopologyReference arg)
Construct a new builder initialized from specifiedNetworkTopologyReference
.- Parameters:
arg
- NetworkTopologyReference from which the builder should be initialized
-
PcepDestroyTunnelInputBuilder
public PcepDestroyTunnelInputBuilder(PcepDestroyTunnelInput base)
Construct a builder initialized with state from specifiedPcepDestroyTunnelInput
.- Parameters:
base
- PcepDestroyTunnelInput 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
-
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
-
getLinkId
public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId getLinkId()
Return current value associated with the property corresponding toBaseTunnelInput.getLinkId()
.- Returns:
- current value
-
getNetworkTopologyRef
public NetworkTopologyRef getNetworkTopologyRef()
Return current value associated with the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
.- 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<PcepDestroyTunnelInput>> 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
-
setDeadline
public PcepDestroyTunnelInputBuilder setDeadline(Nanotime value)
Set the property corresponding toSubmitInstructionInput.getDeadline()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setId
public PcepDestroyTunnelInputBuilder setId(InstructionId value)
Set the property corresponding toSubmitInstructionInput.getId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLinkId
public PcepDestroyTunnelInputBuilder setLinkId(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value)
Set the property corresponding toBaseTunnelInput.getLinkId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNetworkTopologyRef
public PcepDestroyTunnelInputBuilder setNetworkTopologyRef(NetworkTopologyRef value)
Set the property corresponding toNetworkTopologyReference.getNetworkTopologyRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPreconditions
public PcepDestroyTunnelInputBuilder setPreconditions(Set<InstructionId> values)
Set the property corresponding toSubmitInstructionInput.getPreconditions()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public PcepDestroyTunnelInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepDestroyTunnelInput> 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 PcepDestroyTunnelInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepDestroyTunnelInput>> 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 PcepDestroyTunnelInput build()
A newPcepDestroyTunnelInput
instance.- Returns:
- A new
PcepDestroyTunnelInput
instance.
-
-