org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.unreach.destination.object

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>

public class UnreachDestinationObjBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<UnreachDestinationObj>

Class that builds UnreachDestinationObjBuilder 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 and Description
UnreachDestinationObjBuilder()
UnreachDestinationObjBuilder(Object arg)
UnreachDestinationObjBuilder(ObjectHeader arg)
UnreachDestinationObjBuilder(UnreachDestinationObj base)

Method Summary

Modifier and Type	Method and Description
UnreachDestinationObjBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj> augmentationValue)
<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	isIgnore()
Boolean	isProcessingRule()
UnreachDestinationObjBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj>> augmentationType)
UnreachDestinationObjBuilder	setDestination(Destination value)
UnreachDestinationObjBuilder	setIgnore(Boolean value)
UnreachDestinationObjBuilder	setProcessingRule(Boolean value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getDestination

public Destination getDestination()

isIgnore

public Boolean isIgnore()

isProcessingRule

public Boolean isProcessingRule()

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(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj>> augmentationType,
                                                    org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj> augmentationValue)

removeAugmentation

public UnreachDestinationObjBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UnreachDestinationObj>> augmentationType)

build

public UnreachDestinationObj build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<UnreachDestinationObj,IllegalArgumentException>