Class CLabeledUnicastDestinationBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.labeled.unicast.destination.CLabeledUnicastDestinationBuilder
Class that builds
CLabeledUnicastDestination
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:
CLabeledUnicastDestination createCLabeledUnicastDestination(int fooXyzzy, int barBaz) {
return new CLabeledUnicastDestinationBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of CLabeledUnicastDestination, 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 specifiedCLabeledUnicastDestination
.Construct a new builder initialized from specifiedLabeledUnicast
.Construct a new builder initialized from specifiedPathIdGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<CLabeledUnicastDestination> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CLabeledUnicastDestination>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull CLabeledUnicastDestination
build()
A newCLabeledUnicastDestination
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toLabeledUnicast.getLabelStack()
.Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
Return current value associated with the property corresponding toLabeledUnicast.getPrefix()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CLabeledUnicastDestination>> augmentationType) Remove an augmentation from this builder's product.setLabelStack
(List<LabelStack> values) Set the property corresponding toLabeledUnicast.getLabelStack()
to the specified value.Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.setPrefix
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value) Set the property corresponding toLabeledUnicast.getPrefix()
to the specified value.
-
Constructor Details
-
CLabeledUnicastDestinationBuilder
public CLabeledUnicastDestinationBuilder()Construct an empty builder. -
CLabeledUnicastDestinationBuilder
Construct a new builder initialized from specifiedLabeledUnicast
.- Parameters:
arg
- LabeledUnicast from which the builder should be initialized
-
CLabeledUnicastDestinationBuilder
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
CLabeledUnicastDestinationBuilder
Construct a builder initialized with state from specifiedCLabeledUnicastDestination
.- Parameters:
base
- CLabeledUnicastDestination 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
-
getLabelStack
Return current value associated with the property corresponding toLabeledUnicast.getLabelStack()
.- Returns:
- current value
-
getPathId
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.- Returns:
- current value
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()Return current value associated with the property corresponding toLabeledUnicast.getPrefix()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<CLabeledUnicastDestination>> 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
-
setLabelStack
Set the property corresponding toLabeledUnicast.getLabelStack()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setPathId
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefix
public CLabeledUnicastDestinationBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value) Set the property corresponding toLabeledUnicast.getPrefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public CLabeledUnicastDestinationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<CLabeledUnicastDestination> 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 CLabeledUnicastDestinationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<CLabeledUnicastDestination>> 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 newCLabeledUnicastDestination
instance.- Returns:
- A new
CLabeledUnicastDestination
instance.
-