org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.secondary.reported.route.object.srro

Class SubobjectBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.secondary.reported.route.object.srro.SubobjectBuilder

All Implemented Interfaces:

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

public class SubobjectBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Subobject>

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

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

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

SubobjectBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
SubobjectBuilder()
SubobjectBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.RecordRouteSubobjects arg)
SubobjectBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.SecondaryRecordRouteSubobjects arg)
SubobjectBuilder(Subobject base)

Method Summary

Modifier and Type	Method and Description
SubobjectBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subobject>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Subobject> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Subobject>> E$$	augmentation(Class<E$$> augmentationType)
Subobject	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.record.route.subobjects.SubobjectType	getSubobjectType()
Boolean	isProtectionAvailable()
Boolean	isProtectionInUse()
SubobjectBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Subobject>> augmentationType)
SubobjectBuilder	setProtectionAvailable(Boolean value)
SubobjectBuilder	setProtectionInUse(Boolean value)
SubobjectBuilder	setSubobjectType(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.record.route.subobjects.SubobjectType value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubobjectBuilder

public SubobjectBuilder()

SubobjectBuilder

public SubobjectBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.SecondaryRecordRouteSubobjects arg)

SubobjectBuilder

public SubobjectBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.RecordRouteSubobjects arg)

SubobjectBuilder

public SubobjectBuilder(Subobject 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.RecordRouteSubobjects
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.SecondaryRecordRouteSubobjects

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getSubobjectType

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.record.route.subobjects.SubobjectType getSubobjectType()

isProtectionAvailable

public Boolean isProtectionAvailable()

isProtectionInUse

public Boolean isProtectionInUse()

augmentation

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

setSubobjectType

public SubobjectBuilder setSubobjectType(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.record.route.subobjects.SubobjectType value)

setProtectionAvailable

public SubobjectBuilder setProtectionAvailable(Boolean value)

setProtectionInUse

public SubobjectBuilder setProtectionInUse(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public Subobject build()

Specified by:

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