Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter

Class MeterBandHeadersBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.MeterBandHeadersBuilder

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

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

   
     MeterBandHeaders createMeterBandHeaders(int fooXyzzy, int barBaz) {
         return new MeterBandHeadersBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• MeterBandHeaders

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MeterBandHeadersBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeaders> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeaders>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull MeterBandHeaders	build()	A new MeterBandHeaders instance.
static @NonNull MeterBandHeaders	empty()	Get empty instance of MeterBandHeaders.
Map<MeterBandHeaderKey,MeterBandHeader>	getMeterBandHeader()	Return current value associated with the property corresponding to MeterBandHeaders.getMeterBandHeader().
MeterBandHeadersBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MeterBandHeaders>> augmentationType)	Remove an augmentation from this builder's product.
MeterBandHeadersBuilder	setMeterBandHeader(Map<MeterBandHeaderKey,MeterBandHeader> values)	Set the property corresponding to MeterBandHeaders.getMeterBandHeader() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

MeterBandHeadersBuilder

public MeterBandHeadersBuilder()

Construct an empty builder.

MeterBandHeadersBuilder

public MeterBandHeadersBuilder(MeterBandHeaders base)

Construct a builder initialized with state from specified MeterBandHeaders.

Parameters:

base - MeterBandHeaders from which the builder should be initialized

Method Details

empty

public static @NonNull MeterBandHeaders empty()

Get empty instance of MeterBandHeaders.

Returns:

An empty MeterBandHeaders

getMeterBandHeader

public Map<MeterBandHeaderKey,MeterBandHeader> getMeterBandHeader()

Return current value associated with the property corresponding to MeterBandHeaders.getMeterBandHeader().

Returns:

current value

augmentation

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

setMeterBandHeader

public MeterBandHeadersBuilder setMeterBandHeader(Map<MeterBandHeaderKey,MeterBandHeader> values)

Set the property corresponding to MeterBandHeaders.getMeterBandHeader() to the specified value.

Parameters:

values - desired value

Returns:

this builder

addAugmentation

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

A new MeterBandHeaders instance.

Returns:

A new MeterBandHeaders instance.