org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111

Class GetGroupDescriptionInputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.group.statistics.rev131111.GetGroupDescriptionInputBuilder

All Implemented Interfaces:

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

public class GetGroupDescriptionInputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<GetGroupDescriptionInput>

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

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

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

GetGroupDescriptionInputBuilder, Builder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
GetGroupDescriptionInputBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupDescriptionInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupDescriptionInput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupDescriptionInput>> E$$	augmentation(Class<E$$> augmentationType)
GetGroupDescriptionInput	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()
GetGroupDescriptionInputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetGroupDescriptionInput>> augmentationType)
GetGroupDescriptionInputBuilder	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

GetGroupDescriptionInputBuilder

public GetGroupDescriptionInputBuilder()

GetGroupDescriptionInputBuilder

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

GetGroupDescriptionInputBuilder

public GetGroupDescriptionInputBuilder(GetGroupDescriptionInput 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<GetGroupDescriptionInput>> E$$ augmentation(Class<E$$> augmentationType)

setNode

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

addAugmentation

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

removeAugmentation

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

build

public GetGroupDescriptionInput build()

Specified by:

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