Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.alarms.rev190709.alarms.top.alarms.alarm

Class StateBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.alarms.rev190709.alarms.top.alarms.alarm.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 State 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:

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

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

State, Builder

Constructor Summary

Constructors

Constructor	Description
StateBuilder()
StateBuilder(AlarmConfig arg)
StateBuilder(State base)
StateBuilder(AlarmState 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.
String	getId()
String	getResource()
Class<? extends OPENCONFIGALARMSEVERITY>	getSeverity()
String	getText()
Timeticks64	getTimeCreated()
AlarmState.TypeId	getTypeId()
StateBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> augmentationType)	Remove an augmentation from this builder's product.
StateBuilder	setId(String value)
StateBuilder	setResource(String value)
StateBuilder	setSeverity(Class<? extends OPENCONFIGALARMSEVERITY> value)
StateBuilder	setText(String value)
StateBuilder	setTimeCreated(Timeticks64 value)
StateBuilder	setTypeId(AlarmState.TypeId 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(AlarmConfig arg)

StateBuilder

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

• AlarmState
• AlarmConfig

Parameters:

arg - grouping object

Throws:

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

getId

public String getId()

getResource

public String getResource()

getSeverity

public Class<? extends OPENCONFIGALARMSEVERITY> getSeverity()

getText

public String getText()

getTimeCreated

public Timeticks64 getTimeCreated()

getTypeId

public AlarmState.TypeId getTypeId()

augmentation

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

setId

public StateBuilder setId(String value)

setResource

public StateBuilder setResource(String value)

setSeverity

public StateBuilder setSeverity(Class<? extends OPENCONFIGALARMSEVERITY> value)

setText

public StateBuilder setText(String value)

setTimeCreated

public StateBuilder setTimeCreated(Timeticks64 value)

setTypeId

public StateBuilder setTypeId(AlarmState.TypeId 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>