Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter._case

Class MultipartReplyMeterBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.meter._case.MultipartReplyMeterBuilder

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

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

   
     MultipartReplyMeter createMultipartReplyMeter(int fooXyzzy, int barBaz) {
         return new MultipartReplyMeterBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• MultipartReplyMeter

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

MultipartReplyMeterBuilder

public MultipartReplyMeterBuilder()

Construct an empty builder.

MultipartReplyMeterBuilder

public MultipartReplyMeterBuilder(MultipartReplyMeter base)

Construct a builder initialized with state from specified MultipartReplyMeter.

Parameters:

base - MultipartReplyMeter from which the builder should be initialized

Method Details

empty

public static @NonNull MultipartReplyMeter empty()

Get empty instance of MultipartReplyMeter.

Returns:

An empty MultipartReplyMeter

getMeterStats

public List<MeterStats> getMeterStats()

Return current value associated with the property corresponding to MultipartReplyMeter.getMeterStats().

Returns:

current value

augmentation

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

setMeterStats

public MultipartReplyMeterBuilder setMeterStats(List<MeterStats> values)

Set the property corresponding to MultipartReplyMeter.getMeterStats() to the specified value.

Parameters:

values - desired value

Returns:

this builder

addAugmentation

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

A new MultipartReplyMeter instance.

Returns:

A new MultipartReplyMeter instance.