Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111

Class GetAllMeterConfigStatisticsInputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.GetAllMeterConfigStatisticsInputBuilder

@Generated("mdsal-binding-generator")
public class GetAllMeterConfigStatisticsInputBuilder
extends Object

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

   
     GetAllMeterConfigStatisticsInput createGetAllMeterConfigStatisticsInput(int fooXyzzy, int barBaz) {
         return new GetAllMeterConfigStatisticsInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• GetAllMeterConfigStatisticsInput

Constructor Summary

Constructors

Constructor	Description
GetAllMeterConfigStatisticsInputBuilder()	Construct an empty builder.
GetAllMeterConfigStatisticsInputBuilder(NodeContextRef arg)	Construct a new builder initialized from specified NodeContextRef.
GetAllMeterConfigStatisticsInputBuilder(GetAllMeterConfigStatisticsInput base)	Construct a builder initialized with state from specified GetAllMeterConfigStatisticsInput.

Method Summary

Modifier and Type	Method	Description
GetAllMeterConfigStatisticsInputBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetAllMeterConfigStatisticsInput> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetAllMeterConfigStatisticsInput>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull GetAllMeterConfigStatisticsInput	build()	A new GetAllMeterConfigStatisticsInput instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
NodeRef	getNode()	Return current value associated with the property corresponding to NodeContextRef.getNode().
GetAllMeterConfigStatisticsInputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetAllMeterConfigStatisticsInput>> augmentationType)	Remove an augmentation from this builder's product.
GetAllMeterConfigStatisticsInputBuilder	setNode(NodeRef value)	Set the property corresponding to NodeContextRef.getNode() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

GetAllMeterConfigStatisticsInputBuilder

public GetAllMeterConfigStatisticsInputBuilder()

Construct an empty builder.

GetAllMeterConfigStatisticsInputBuilder

public GetAllMeterConfigStatisticsInputBuilder(NodeContextRef arg)

Construct a new builder initialized from specified NodeContextRef.

Parameters:

arg - NodeContextRef from which the builder should be initialized

GetAllMeterConfigStatisticsInputBuilder

public GetAllMeterConfigStatisticsInputBuilder(GetAllMeterConfigStatisticsInput base)

Construct a builder initialized with state from specified GetAllMeterConfigStatisticsInput.

Parameters:

base - GetAllMeterConfigStatisticsInput from which the builder should be initialized

Method Details

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:

• NodeContextRef

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

getNode

public NodeRef getNode()

Return current value associated with the property corresponding to NodeContextRef.getNode().

Returns:

current value

augmentation

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

Return the specified augmentation, if it is present in this builder.

Type Parameters:

E$$ - augmentation type

Parameters:

augmentationType - augmentation type class

Returns:

Augmentation object from this builder, or null if not present

Throws:

NullPointerException - if augmentType is null

setNode

public GetAllMeterConfigStatisticsInputBuilder setNode(NodeRef value)

Set the property corresponding to NodeContextRef.getNode() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

public GetAllMeterConfigStatisticsInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetAllMeterConfigStatisticsInput> augmentation)

Add an augmentation to this builder's product.

Parameters:

augmentation - augmentation to be added

Returns:

this builder

Throws:

NullPointerException - if augmentation is null

removeAugmentation

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

Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.

Parameters:

augmentationType - augmentation type to be removed

Returns:

this builder

build

public @NonNull GetAllMeterConfigStatisticsInput build()

A new GetAllMeterConfigStatisticsInput instance.

Returns:

A new GetAllMeterConfigStatisticsInput instance.