Class TopologyTunnelPcepBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev181109.topology.tunnel.pcep.type.TopologyTunnelPcepBuilder
Class that builds
TopologyTunnelPcep
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:
TopologyTunnelPcep createTopologyTunnelPcep(int fooXyzzy, int barBaz) {
return new TopologyTunnelPcepBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of TopologyTunnelPcep, 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 builder initialized with state from specifiedTopologyTunnelPcep
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<TopologyTunnelPcep> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<TopologyTunnelPcep>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull TopologyTunnelPcep
build()
A newTopologyTunnelPcep
instance.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<TopologyTunnelPcep>> augmentationType) Remove an augmentation from this builder's product.
-
Constructor Details
-
TopologyTunnelPcepBuilder
public TopologyTunnelPcepBuilder()Construct an empty builder. -
TopologyTunnelPcepBuilder
Construct a builder initialized with state from specifiedTopologyTunnelPcep
.- Parameters:
base
- TopologyTunnelPcep from which the builder should be initialized
-
-
Method Details
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<TopologyTunnelPcep>> 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
-
addAugmentation
public TopologyTunnelPcepBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<TopologyTunnelPcep> 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 TopologyTunnelPcepBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<TopologyTunnelPcep>> 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 newTopologyTunnelPcep
instance.- Returns:
- A new
TopologyTunnelPcep
instance.
-