org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.admin.status.object

Class AdminStatusObjectBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.admin.status.object.AdminStatusObjectBuilder

All Implemented Interfaces:

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

public class AdminStatusObjectBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<AdminStatusObject>

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

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

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

AdminStatusObjectBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
AdminStatusObjectBuilder()
AdminStatusObjectBuilder(AdminStatusObject base)
AdminStatusObjectBuilder(RsvpTeObject arg)

Method Summary

Modifier and Type	Method and Description
AdminStatusObjectBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AdminStatusObject>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AdminStatusObject> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AdminStatusObject>> E$$	augmentation(Class<E$$> augmentationType)
AdminStatusObject	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Boolean	isAdministrativelyDown()
Boolean	isDeletionInProgress()
Boolean	isReflect()
Boolean	isTesting()
AdminStatusObjectBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AdminStatusObject>> augmentationType)
AdminStatusObjectBuilder	setAdministrativelyDown(Boolean value)
AdminStatusObjectBuilder	setDeletionInProgress(Boolean value)
AdminStatusObjectBuilder	setReflect(Boolean value)
AdminStatusObjectBuilder	setTesting(Boolean value)

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminStatusObjectBuilder

public AdminStatusObjectBuilder()

AdminStatusObjectBuilder

public AdminStatusObjectBuilder(RsvpTeObject arg)

AdminStatusObjectBuilder

public AdminStatusObjectBuilder(AdminStatusObject 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.RsvpTeObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

isAdministrativelyDown

public Boolean isAdministrativelyDown()

isDeletionInProgress

public Boolean isDeletionInProgress()

isReflect

public Boolean isReflect()

isTesting

public Boolean isTesting()

augmentation

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

setAdministrativelyDown

public AdminStatusObjectBuilder setAdministrativelyDown(Boolean value)

setDeletionInProgress

public AdminStatusObjectBuilder setDeletionInProgress(Boolean value)

setReflect

public AdminStatusObjectBuilder setReflect(Boolean value)

setTesting

public AdminStatusObjectBuilder setTesting(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public AdminStatusObject build()

Specified by:

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