org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.primary.path.route.object

Class PrimaryPathRouteObjectBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.primary.path.route.object.PrimaryPathRouteObjectBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<PrimaryPathRouteObject>, org.opendaylight.yangtools.concepts.CheckedBuilder<PrimaryPathRouteObject,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class PrimaryPathRouteObjectBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PrimaryPathRouteObject>

Class that builds PrimaryPathRouteObjectBuilder 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:

   
     PrimaryPathRouteObjectBuilder createTarget(int fooXyzzy, int barBaz) {
         return new PrimaryPathRouteObjectBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of PrimaryPathRouteObjectBuilder, 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:

PrimaryPathRouteObjectBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PrimaryPathRouteObjectBuilder()
PrimaryPathRouteObjectBuilder(ExplicitRouteSubobjectsList arg)
PrimaryPathRouteObjectBuilder(PrimaryPathRouteObject base)
PrimaryPathRouteObjectBuilder(RsvpTeObject arg)

Method Summary

Modifier and Type	Method and Description
PrimaryPathRouteObjectBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrimaryPathRouteObject>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PrimaryPathRouteObject> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrimaryPathRouteObject>> E$$	augmentation(Class<E$$> augmentationType)
PrimaryPathRouteObject	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
List<SubobjectContainer>	getSubobjectContainer()
PrimaryPathRouteObjectBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrimaryPathRouteObject>> augmentationType)
PrimaryPathRouteObjectBuilder	setSubobjectContainer(List<SubobjectContainer> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimaryPathRouteObjectBuilder

public PrimaryPathRouteObjectBuilder()

PrimaryPathRouteObjectBuilder

public PrimaryPathRouteObjectBuilder(RsvpTeObject arg)

PrimaryPathRouteObjectBuilder

public PrimaryPathRouteObjectBuilder(ExplicitRouteSubobjectsList arg)

PrimaryPathRouteObjectBuilder

public PrimaryPathRouteObjectBuilder(PrimaryPathRouteObject 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.rsvp.rev150820.ExplicitRouteSubobjectsList
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.RsvpTeObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getSubobjectContainer

public List<SubobjectContainer> getSubobjectContainer()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrimaryPathRouteObject>> E$$ augmentation(Class<E$$> augmentationType)

setSubobjectContainer

public PrimaryPathRouteObjectBuilder setSubobjectContainer(List<SubobjectContainer> values)

addAugmentation

public PrimaryPathRouteObjectBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrimaryPathRouteObject>> augmentationType,
                                                     org.opendaylight.yangtools.yang.binding.Augmentation<PrimaryPathRouteObject> augmentationValue)

removeAugmentation

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

build

public PrimaryPathRouteObject build()

Specified by:

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