org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.explicit.route.subobjects.list

Class SubobjectContainerBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.explicit.route.subobjects.list.SubobjectContainerBuilder

All Implemented Interfaces:

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

public class SubobjectContainerBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<SubobjectContainer>

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

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

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

SubobjectContainerBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
SubobjectContainerBuilder()
SubobjectContainerBuilder(BasicExplicitRouteSubobjects arg)
SubobjectContainerBuilder(ExplicitRouteSubobjects arg)
SubobjectContainerBuilder(SubobjectContainer base)

Method Summary

Modifier and Type	Method and Description
SubobjectContainerBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>> E$$	augmentation(Class<E$$> augmentationType)
SubobjectContainer	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
SubobjectType	getSubobjectType()
Boolean	isLoose()
SubobjectContainerBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SubobjectContainer>> augmentationType)
SubobjectContainerBuilder	setLoose(Boolean value)
SubobjectContainerBuilder	setSubobjectType(SubobjectType value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubobjectContainerBuilder

public SubobjectContainerBuilder()

SubobjectContainerBuilder

public SubobjectContainerBuilder(ExplicitRouteSubobjects arg)

SubobjectContainerBuilder

public SubobjectContainerBuilder(BasicExplicitRouteSubobjects arg)

SubobjectContainerBuilder

public SubobjectContainerBuilder(SubobjectContainer 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.BasicExplicitRouteSubobjects
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.ExplicitRouteSubobjects

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getSubobjectType

public SubobjectType getSubobjectType()

isLoose

public Boolean isLoose()

augmentation

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

setSubobjectType

public SubobjectContainerBuilder setSubobjectType(SubobjectType value)

setLoose

public SubobjectContainerBuilder setLoose(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public SubobjectContainer build()

Specified by:

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