Class ExplicitHopsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.p2p.rev130819.tunnel.p2p.path.cfg.attributes.ExplicitHopsBuilder
Class that builds
ExplicitHops
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:
ExplicitHops createExplicitHops(int fooXyzzy, int barBaz) {
return new ExplicitHopsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ExplicitHops, 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 builder initialized with state from specifiedExplicitHops
.Construct a new builder initialized from specifiedTunnelP2pPathHops
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitHops> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitHops>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ExplicitHops
build()
A newExplicitHops
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.getLoose()
Return current value associated with the property corresponding toExplicitHops.getLoose()
.org.opendaylight.yangtools.yang.common.Uint32
getOrder()
Return current value associated with the property corresponding toTunnelP2pPathHops.getOrder()
.key()
Return current value associated with the property corresponding toExplicitHops.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitHops>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toExplicitHops.getLoose()
to the specified value.setOrder
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toTunnelP2pPathHops.getOrder()
to the specified value.withKey
(ExplicitHopsKey key) Set the key value corresponding toExplicitHops.key()
to the specified value.
-
Constructor Details
-
ExplicitHopsBuilder
public ExplicitHopsBuilder()Construct an empty builder. -
ExplicitHopsBuilder
Construct a new builder initialized from specifiedTunnelP2pPathHops
.- Parameters:
arg
- TunnelP2pPathHops from which the builder should be initialized
-
ExplicitHopsBuilder
Construct a builder initialized with state from specifiedExplicitHops
.- Parameters:
base
- ExplicitHops from which the builder should be initialized
-
-
Method Details
-
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
-
key
Return current value associated with the property corresponding toExplicitHops.key()
.- Returns:
- current value
-
getLoose
Return current value associated with the property corresponding toExplicitHops.getLoose()
.- Returns:
- current value
-
getOrder
public org.opendaylight.yangtools.yang.common.Uint32 getOrder()Return current value associated with the property corresponding toTunnelP2pPathHops.getOrder()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitHops>> 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
-
withKey
Set the key value corresponding toExplicitHops.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setLoose
Set the property corresponding toExplicitHops.getLoose()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOrder
Set the property corresponding toTunnelP2pPathHops.getOrder()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ExplicitHopsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitHops> 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 ExplicitHopsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExplicitHops>> 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 newExplicitHops
instance.- Returns:
- A new
ExplicitHops
instance.
-