Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.multipart.reply.multipart.reply.body

Class MultipartReplyMeterStatsBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.multipart.reply.multipart.reply.body.MultipartReplyMeterStatsBuilder

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

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

   
     MultipartReplyMeterStats createMultipartReplyMeterStats(int fooXyzzy, int barBaz) {
         return new MultipartReplyMeterStatsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• MultipartReplyMeterStats

Constructor Summary

Constructors

Constructor	Description
MultipartReplyMeterStatsBuilder()	Construct an empty builder.
MultipartReplyMeterStatsBuilder(MultipartReplyMeterStats base)	Construct a builder initialized with state from specified MultipartReplyMeterStats.
MultipartReplyMeterStatsBuilder(MeterStatisticsReply arg)	Construct a new builder initialized from specified MeterStatisticsReply.

Method Summary

Modifier and Type	Method	Description
MultipartReplyMeterStatsBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMeterStats> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMeterStats>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull MultipartReplyMeterStats	build()	A new MultipartReplyMeterStats instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
Map<MeterStatsKey,MeterStats>	getMeterStats()	Return current value associated with the property corresponding to MeterStatisticsReply.getMeterStats().
MultipartReplyMeterStatsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMeterStats>> augmentationType)	Remove an augmentation from this builder's product.
MultipartReplyMeterStatsBuilder	setMeterStats(Map<MeterStatsKey,MeterStats> values)	Set the property corresponding to MeterStatisticsReply.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

MultipartReplyMeterStatsBuilder

public MultipartReplyMeterStatsBuilder()

Construct an empty builder.

MultipartReplyMeterStatsBuilder

public MultipartReplyMeterStatsBuilder(MeterStatisticsReply arg)

Construct a new builder initialized from specified MeterStatisticsReply.

Parameters:

arg - MeterStatisticsReply from which the builder should be initialized

MultipartReplyMeterStatsBuilder

public MultipartReplyMeterStatsBuilder(MultipartReplyMeterStats base)

Construct a builder initialized with state from specified MultipartReplyMeterStats.

Parameters:

base - MultipartReplyMeterStats 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:

• MeterStatisticsReply

Parameters:

arg - grouping object

Throws:

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

getMeterStats

public Map<MeterStatsKey,MeterStats> getMeterStats()

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

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMeterStats>>
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 MultipartReplyMeterStatsBuilder setMeterStats(Map<MeterStatsKey,MeterStats> values)

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

Parameters:

values - desired value

Returns:

this builder

addAugmentation

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

A new MultipartReplyMeterStats instance.

Returns:

A new MultipartReplyMeterStats instance.