org.opendaylight.yang.gen.v1.urn.opendaylight.async.config.service.rev170619

Class GetAsyncInputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.async.config.service.rev170619.GetAsyncInputBuilder

All Implemented Interfaces:

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

public class GetAsyncInputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<GetAsyncInput>

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

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

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

GetAsyncInputBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
GetAsyncInputBuilder()
GetAsyncInputBuilder(GetAsyncInput base)
GetAsyncInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)

Method Summary

Modifier and Type	Method and Description
GetAsyncInputBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetAsyncInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GetAsyncInput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetAsyncInput>> E$$	augmentation(Class<E$$> augmentationType)
GetAsyncInput	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef	getNode()
GetAsyncInputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetAsyncInput>> augmentationType)
GetAsyncInputBuilder	setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)

Methods inherited from class java.lang.Object

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

Constructor Detail

GetAsyncInputBuilder

public GetAsyncInputBuilder()

GetAsyncInputBuilder

public GetAsyncInputBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)

GetAsyncInputBuilder

public GetAsyncInputBuilder(GetAsyncInput 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.inventory.rev130819.NodeContextRef

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getNode

public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()

augmentation

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

setNode

public GetAsyncInputBuilder setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)

addAugmentation

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

removeAugmentation

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

build

public GetAsyncInput build()

Specified by:

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