Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.vlan.rev190416

Class State1Builder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.vlan.rev190416.State1Builder

All Implemented Interfaces:

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

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

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

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

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

State1Builder, Builder

Constructor Summary

Constructors

Constructor	Description
State1Builder()
State1Builder(State1 base)
State1Builder(VlanTpidConfig arg)
State1Builder(VlanTpidState arg)

Method Summary

Modifier and Type	Method	Description
State1	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
Class<? extends TPIDTYPES>	getTpid()
State1Builder	setTpid(Class<? extends TPIDTYPES> value)

Methods inherited from class java.lang.Object

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

Constructor Detail

State1Builder

public State1Builder()

State1Builder

public State1Builder(VlanTpidConfig arg)

State1Builder

public State1Builder(VlanTpidState arg)

State1Builder

public State1Builder(State1 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:

• VlanTpidConfig
• VlanTpidState

Parameters:

arg - grouping object

Throws:

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

getTpid

public Class<? extends TPIDTYPES> getTpid()

setTpid

public State1Builder setTpid(Class<? extends TPIDTYPES> value)

build

public State1 build()

Specified by:

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

Specified by:

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