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

Class UserBuilder

java.lang.Object

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

All Implemented Interfaces:

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

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

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

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

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

UserBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
UserBuilder()
UserBuilder(AvgMinMaxInstantStatsPct arg)
UserBuilder(MinMaxTime arg)
UserBuilder(StatIntervalState arg)
UserBuilder(User base)

Method Summary

Modifier and Type	Method	Description
UserBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<User> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<User>> E$$	augmentation(Class<E$$> augmentationType)
User	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()
UserBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<User>> augmentationType)	Remove an augmentation from this builder's product.
UserBuilder	setAvg(Percentage value)
UserBuilder	setInstant(Percentage value)
UserBuilder	setInterval(StatInterval value)
UserBuilder	setMax(Percentage value)
UserBuilder	setMaxTime(Timeticks64 value)
UserBuilder	setMin(Percentage value)
UserBuilder	setMinTime(Timeticks64 value)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserBuilder

public UserBuilder()

UserBuilder

public UserBuilder(AvgMinMaxInstantStatsPct arg)

UserBuilder

public UserBuilder(StatIntervalState arg)

UserBuilder

public UserBuilder(MinMaxTime arg)

UserBuilder

public UserBuilder(User 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<User>> E$$ augmentation(Class<E$$> augmentationType)

setAvg

public UserBuilder setAvg(Percentage value)

setInstant

public UserBuilder setInstant(Percentage value)

setInterval

public UserBuilder setInterval(StatInterval value)

setMax

public UserBuilder setMax(Percentage value)

setMaxTime

public UserBuilder setMaxTime(Timeticks64 value)

setMin

public UserBuilder setMin(Percentage value)

setMinTime

public UserBuilder setMinTime(Timeticks64 value)

addAugmentation

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

Specified by:

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

Specified by:

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