Class PcepCreateP2pTunnelOutputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.programming.rev181109.PcepCreateP2pTunnelOutputBuilder
Class that builds
PcepCreateP2pTunnelOutput
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:
PcepCreateP2pTunnelOutput createPcepCreateP2pTunnelOutput(int fooXyzzy, int barBaz) {
return new PcepCreateP2pTunnelOutputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of PcepCreateP2pTunnelOutput, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedSubmitInstructionOutput
.Construct a builder initialized with state from specifiedPcepCreateP2pTunnelOutput
.Construct a new builder initialized from specifiedCreateTunnelOutput
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelOutput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelOutput>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull PcepCreateP2pTunnelOutput
build()
A newPcepCreateP2pTunnelOutput
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId
Return current value associated with the property corresponding toCreateTunnelOutput.getLinkId()
.Return current value associated with the property corresponding toSubmitInstructionOutput.getResult()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelOutput>> augmentationType) Remove an augmentation from this builder's product.setLinkId
(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value) Set the property corresponding toCreateTunnelOutput.getLinkId()
to the specified value.Set the property corresponding toSubmitInstructionOutput.getResult()
to the specified value.
-
Constructor Details
-
PcepCreateP2pTunnelOutputBuilder
public PcepCreateP2pTunnelOutputBuilder()Construct an empty builder. -
PcepCreateP2pTunnelOutputBuilder
Construct a new builder initialized from specifiedCreateTunnelOutput
.- Parameters:
arg
- CreateTunnelOutput from which the builder should be initialized
-
PcepCreateP2pTunnelOutputBuilder
Construct a new builder initialized from specifiedSubmitInstructionOutput
.- Parameters:
arg
- SubmitInstructionOutput from which the builder should be initialized
-
PcepCreateP2pTunnelOutputBuilder
Construct a builder initialized with state from specifiedPcepCreateP2pTunnelOutput
.- Parameters:
base
- PcepCreateP2pTunnelOutput 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
-
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 toCreateTunnelOutput.getLinkId()
.- Returns:
- current value
-
getResult
Return current value associated with the property corresponding toSubmitInstructionOutput.getResult()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelOutput>> 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
-
setLinkId
public PcepCreateP2pTunnelOutputBuilder setLinkId(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value) Set the property corresponding toCreateTunnelOutput.getLinkId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setResult
Set the property corresponding toSubmitInstructionOutput.getResult()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PcepCreateP2pTunnelOutputBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelOutput> 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 PcepCreateP2pTunnelOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<PcepCreateP2pTunnelOutput>> 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 newPcepCreateP2pTunnelOutput
instance.- Returns:
- A new
PcepCreateP2pTunnelOutput
instance.
-