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

Class StateBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.cpu.top.cpus.cpu.StateBuilder

All Implemented Interfaces:

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

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

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

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

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

StateBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
StateBuilder()
StateBuilder(State base)
StateBuilder(SystemCpuState arg)

Method Summary

Modifier and Type	Method	Description
StateBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<State> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> E$$	augmentation(Class<E$$> augmentationType)
State	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
HardwareInterrupt	getHardwareInterrupt()
Idle	getIdle()
SystemCpuState.Index	getIndex()
Kernel	getKernel()
Nice	getNice()
SoftwareInterrupt	getSoftwareInterrupt()
Total	getTotal()
User	getUser()
Wait	getWait()
StateBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)	Remove an augmentation from this builder's product.
StateBuilder	setHardwareInterrupt(HardwareInterrupt value)
StateBuilder	setIdle(Idle value)
StateBuilder	setIndex(SystemCpuState.Index value)
StateBuilder	setKernel(Kernel value)
StateBuilder	setNice(Nice value)
StateBuilder	setSoftwareInterrupt(SoftwareInterrupt value)
StateBuilder	setTotal(Total value)
StateBuilder	setUser(User value)
StateBuilder	setWait(Wait value)

Methods inherited from class java.lang.Object

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

Constructor Detail

StateBuilder

public StateBuilder()

StateBuilder

public StateBuilder(SystemCpuState arg)

StateBuilder

public StateBuilder(State 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:

• SystemCpuState

Parameters:

arg - grouping object

Throws:

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

getHardwareInterrupt

public HardwareInterrupt getHardwareInterrupt()

getIdle

public Idle getIdle()

getIndex

public SystemCpuState.Index getIndex()

getKernel

public Kernel getKernel()

getNice

public Nice getNice()

getSoftwareInterrupt

public SoftwareInterrupt getSoftwareInterrupt()

getTotal

public Total getTotal()

getUser

public User getUser()

getWait

public Wait getWait()

augmentation

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

setHardwareInterrupt

public StateBuilder setHardwareInterrupt(HardwareInterrupt value)

setIdle

public StateBuilder setIdle(Idle value)

setIndex

public StateBuilder setIndex(SystemCpuState.Index value)

setKernel

public StateBuilder setKernel(Kernel value)

setNice

public StateBuilder setNice(Nice value)

setSoftwareInterrupt

public StateBuilder setSoftwareInterrupt(SoftwareInterrupt value)

setTotal

public StateBuilder setTotal(Total value)

setUser

public StateBuilder setUser(User value)

setWait

public StateBuilder setWait(Wait value)

addAugmentation

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

Specified by:

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

Specified by:

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