Class UnreachDestinationObjBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.unreach.destination.object.UnreachDestinationObjBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<UnreachDestinationObj>
,org.opendaylight.yangtools.concepts.CheckedBuilder<UnreachDestinationObj,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class UnreachDestinationObjBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<UnreachDestinationObj>
Class that buildsUnreachDestinationObjBuilder
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:
UnreachDestinationObjBuilder createTarget(int fooXyzzy, int barBaz) { return new UnreachDestinationObjBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UnreachDestinationObjBuilder, 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 oportunities, 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:
UnreachDestinationObjBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description UnreachDestinationObjBuilder()
UnreachDestinationObjBuilder(Object arg)
UnreachDestinationObjBuilder(ObjectHeader arg)
UnreachDestinationObjBuilder(UnreachDestinationObj base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
UnreachDestinationObj
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Destination
getDestination()
Boolean
getIgnore()
Boolean
getProcessingRule()
Boolean
isIgnore()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isProcessingRule()
Deprecated, for removal: This API element is subject to removal in a future version.UnreachDestinationObjBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj>> augmentationType)
Remove an augmentation from this builder's product.UnreachDestinationObjBuilder
setDestination(Destination value)
UnreachDestinationObjBuilder
setIgnore(Boolean value)
UnreachDestinationObjBuilder
setProcessingRule(Boolean value)
-
-
-
Constructor Detail
-
UnreachDestinationObjBuilder
public UnreachDestinationObjBuilder()
-
UnreachDestinationObjBuilder
public UnreachDestinationObjBuilder(Object arg)
-
UnreachDestinationObjBuilder
public UnreachDestinationObjBuilder(ObjectHeader arg)
-
UnreachDestinationObjBuilder
public UnreachDestinationObjBuilder(UnreachDestinationObj base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getDestination
public Destination getDestination()
-
getIgnore
public Boolean getIgnore()
-
isIgnore
@Deprecated(forRemoval=true) public final Boolean isIgnore()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getProcessingRule
public Boolean getProcessingRule()
-
isProcessingRule
@Deprecated(forRemoval=true) public final Boolean isProcessingRule()
Deprecated, for removal: This API element is subject to removal in a future version.
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj>> E$$ augmentation(Class<E$$> augmentationType)
-
setDestination
public UnreachDestinationObjBuilder setDestination(Destination value)
-
setIgnore
public UnreachDestinationObjBuilder setIgnore(Boolean value)
-
setProcessingRule
public UnreachDestinationObjBuilder setProcessingRule(Boolean value)
-
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 UnreachDestinationObj build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<UnreachDestinationObj>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<UnreachDestinationObj,IllegalArgumentException>
-
-