Class UnreachDestinationObjBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.unreach.destination.object.UnreachDestinationObjBuilder
-
@Generated("mdsal-binding-generator") public class UnreachDestinationObjBuilder extends Object
Class that buildsUnreachDestinationObj
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:
UnreachDestinationObj createUnreachDestinationObj(int fooXyzzy, int barBaz) { return new UnreachDestinationObjBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UnreachDestinationObj, 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:
UnreachDestinationObj
- 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
-
-
Constructor Summary
Constructors Constructor Description UnreachDestinationObjBuilder()
Construct an empty builder.UnreachDestinationObjBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.UnreachDestinationObjBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.UnreachDestinationObjBuilder(UnreachDestinationObj base)
Construct a builder initialized with state from specifiedUnreachDestinationObj
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UnreachDestinationObjBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull UnreachDestinationObj
build()
A newUnreachDestinationObj
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Destination
getDestination()
Return current value associated with the property corresponding toUnreachDestinationObj.getDestination()
.Boolean
getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.Boolean
getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.UnreachDestinationObjBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj>> augmentationType)
Remove an augmentation from this builder's product.UnreachDestinationObjBuilder
setDestination(Destination value)
Set the property corresponding toUnreachDestinationObj.getDestination()
to the specified value.UnreachDestinationObjBuilder
setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.UnreachDestinationObjBuilder
setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.
-
-
-
Constructor Detail
-
UnreachDestinationObjBuilder
public UnreachDestinationObjBuilder()
Construct an empty builder.
-
UnreachDestinationObjBuilder
public UnreachDestinationObjBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
UnreachDestinationObjBuilder
public UnreachDestinationObjBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
UnreachDestinationObjBuilder
public UnreachDestinationObjBuilder(UnreachDestinationObj base)
Construct a builder initialized with state from specifiedUnreachDestinationObj
.- Parameters:
base
- UnreachDestinationObj from which the builder should be initialized
-
-
Method Detail
-
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
-
getDestination
public Destination getDestination()
Return current value associated with the property corresponding toUnreachDestinationObj.getDestination()
.- Returns:
- current value
-
getIgnore
public Boolean getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getProcessingRule
public Boolean getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj>> 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
-
setDestination
public UnreachDestinationObjBuilder setDestination(Destination value)
Set the property corresponding toUnreachDestinationObj.getDestination()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgnore
public UnreachDestinationObjBuilder setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
public UnreachDestinationObjBuilder setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UnreachDestinationObjBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj> 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 UnreachDestinationObjBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj>> 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
public @NonNull UnreachDestinationObj build()
A newUnreachDestinationObj
instance.- Returns:
- A new
UnreachDestinationObj
instance.
-
-