Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.cpu.state

Class NiceBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.cpu.state.NiceBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<Nice>, org.opendaylight.yangtools.concepts.CheckedBuilder<Nice,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

@Generated("mdsal-binding-generator")
public class NiceBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Nice>

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

   
     NiceBuilder createTarget(int fooXyzzy, int barBaz) {
         return new NiceBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

NiceBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
NiceBuilder()
NiceBuilder(AvgMinMaxInstantStatsPct arg)
NiceBuilder(MinMaxTime arg)
NiceBuilder(StatIntervalState arg)
NiceBuilder(Nice base)

Method Summary

Modifier and Type	Method	Description
NiceBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Nice> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Nice>> E$$	augmentation(Class<E$$> augmentationType)
Nice	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
Percentage	getAvg()
Percentage	getInstant()
StatInterval	getInterval()
Percentage	getMax()
Timeticks64	getMaxTime()
Percentage	getMin()
Timeticks64	getMinTime()
NiceBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Nice>> augmentationType)	Remove an augmentation from this builder's product.
NiceBuilder	setAvg(Percentage value)
NiceBuilder	setInstant(Percentage value)
NiceBuilder	setInterval(StatInterval value)
NiceBuilder	setMax(Percentage value)
NiceBuilder	setMaxTime(Timeticks64 value)
NiceBuilder	setMin(Percentage value)
NiceBuilder	setMinTime(Timeticks64 value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NiceBuilder

public NiceBuilder()

NiceBuilder

public NiceBuilder(AvgMinMaxInstantStatsPct arg)

NiceBuilder

public NiceBuilder(StatIntervalState arg)

NiceBuilder

public NiceBuilder(MinMaxTime arg)

NiceBuilder

public NiceBuilder(Nice base)

Method Detail

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:

• StatIntervalState
• MinMaxTime
• AvgMinMaxInstantStatsPct

Parameters:

arg - grouping object

Throws:

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

getAvg

public Percentage getAvg()

getInstant

public Percentage getInstant()

getInterval

public StatInterval getInterval()

getMax

public Percentage getMax()

getMaxTime

public Timeticks64 getMaxTime()

getMin

public Percentage getMin()

getMinTime

public Timeticks64 getMinTime()

augmentation

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

setAvg

public NiceBuilder setAvg(Percentage value)

setInstant

public NiceBuilder setInstant(Percentage value)

setInterval

public NiceBuilder setInterval(StatInterval value)

setMax

public NiceBuilder setMax(Percentage value)

setMaxTime

public NiceBuilder setMaxTime(Timeticks64 value)

setMin

public NiceBuilder setMin(Percentage value)

setMinTime

public NiceBuilder setMinTime(Timeticks64 value)

addAugmentation

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

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<Nice>

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Nice,IllegalArgumentException>