Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.pmsi.tunnel
Class PmsiTunnelBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.pmsi.tunnel.PmsiTunnelBuilder
Class that builds
PmsiTunnel
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:
PmsiTunnel createPmsiTunnel(int fooXyzzy, int barBaz) {
return new PmsiTunnelBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of PmsiTunnel, 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.PmsiTunnelBuilder
(PmsiTunnel base) Construct a builder initialized with state from specifiedPmsiTunnel
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull PmsiTunnel
build()
A newPmsiTunnel
instance.Return current value associated with the property corresponding toPmsiTunnel.getLeafInformationRequired()
.Return current value associated with the property corresponding toPmsiTunnel.getMplsLabel()
.Return current value associated with the property corresponding toPmsiTunnel.getTunnelIdentifier()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toPmsiTunnel.getLeafInformationRequired()
to the specified value.setMplsLabel
(MplsLabel value) Set the property corresponding toPmsiTunnel.getMplsLabel()
to the specified value.Set the property corresponding toPmsiTunnel.getTunnelIdentifier()
to the specified value.
-
Constructor Details
-
PmsiTunnelBuilder
public PmsiTunnelBuilder()Construct an empty builder. -
PmsiTunnelBuilder
Construct a builder initialized with state from specifiedPmsiTunnel
.- Parameters:
base
- PmsiTunnel from which the builder should be initialized
-
-
Method Details
-
getLeafInformationRequired
Return current value associated with the property corresponding toPmsiTunnel.getLeafInformationRequired()
.- Returns:
- current value
-
getMplsLabel
Return current value associated with the property corresponding toPmsiTunnel.getMplsLabel()
.- Returns:
- current value
-
getTunnelIdentifier
Return current value associated with the property corresponding toPmsiTunnel.getTunnelIdentifier()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel>> 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
-
setLeafInformationRequired
Set the property corresponding toPmsiTunnel.getLeafInformationRequired()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMplsLabel
Set the property corresponding toPmsiTunnel.getMplsLabel()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTunnelIdentifier
Set the property corresponding toPmsiTunnel.getTunnelIdentifier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PmsiTunnelBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel> 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 PmsiTunnelBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PmsiTunnel>> 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 newPmsiTunnel
instance.- Returns:
- A new
PmsiTunnel
instance.
-