Package org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.flat.batch.failure.ids.aug

Class FlatBatchFailureMeterIdCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.flat.batch.failure.ids.aug.FlatBatchFailureMeterIdCaseBuilder

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

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

   
     FlatBatchFailureMeterIdCase createFlatBatchFailureMeterIdCase(int fooXyzzy, int barBaz) {
         return new FlatBatchFailureMeterIdCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• FlatBatchFailureMeterIdCase

Constructor Summary

Constructors

Constructor	Description
FlatBatchFailureMeterIdCaseBuilder()	Construct an empty builder.
FlatBatchFailureMeterIdCaseBuilder(FlatBatchFailureMeterIdCase base)	Construct a builder initialized with state from specified FlatBatchFailureMeterIdCase.

Method Summary

Modifier and Type	Method	Description
FlatBatchFailureMeterIdCaseBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureMeterIdCase> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureMeterIdCase>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull FlatBatchFailureMeterIdCase	build()	A new FlatBatchFailureMeterIdCase instance.
MeterId	getMeterId()	Return current value associated with the property corresponding to FlatBatchFailureMeterIdCase.getMeterId().
FlatBatchFailureMeterIdCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureMeterIdCase>> augmentationType)	Remove an augmentation from this builder's product.
FlatBatchFailureMeterIdCaseBuilder	setMeterId(MeterId value)	Set the property corresponding to FlatBatchFailureMeterIdCase.getMeterId() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

FlatBatchFailureMeterIdCaseBuilder

public FlatBatchFailureMeterIdCaseBuilder()

Construct an empty builder.

FlatBatchFailureMeterIdCaseBuilder

public FlatBatchFailureMeterIdCaseBuilder(FlatBatchFailureMeterIdCase base)

Construct a builder initialized with state from specified FlatBatchFailureMeterIdCase.

Parameters:

base - FlatBatchFailureMeterIdCase from which the builder should be initialized

Method Details

getMeterId

public MeterId getMeterId()

Return current value associated with the property corresponding to FlatBatchFailureMeterIdCase.getMeterId().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureMeterIdCase>>
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

setMeterId

public FlatBatchFailureMeterIdCaseBuilder setMeterId(MeterId value)

Set the property corresponding to FlatBatchFailureMeterIdCase.getMeterId() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

public FlatBatchFailureMeterIdCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureMeterIdCase> 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 FlatBatchFailureMeterIdCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureMeterIdCase>> 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 FlatBatchFailureMeterIdCase build()

A new FlatBatchFailureMeterIdCase instance.

Returns:

A new FlatBatchFailureMeterIdCase instance.