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
@Generated("mdsal-binding-generator") public class State1Builder extends Object
Class that builds State1 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: 

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

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

  • Constructor Details

    • State1Builder

      public State1Builder()
      Construct an empty builder.

    • State1Builder

      public State1Builder(VlanTpidConfig arg)
      Construct a new builder initialized from specified VlanTpidConfig.
      Parameters:
      arg - VlanTpidConfig from which the builder should be initialized

    • State1Builder

      public State1Builder(VlanTpidState arg)
      Construct a new builder initialized from specified VlanTpidState.
      Parameters:
      arg - VlanTpidState from which the builder should be initialized

    • State1Builder

      public State1Builder(State1 base)
      Construct a builder initialized with state from specified State1.
      Parameters:
      base - State1 from which the builder should be initialized

  • Method Details

    • 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:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • getTpid

      public TPIDTYPES getTpid()
      Return current value associated with the property corresponding to VlanTpidConfig.getTpid().
      Returns:
      current value

    • setTpid

      public State1Builder setTpid(TPIDTYPES value)
      Set the property corresponding to VlanTpidConfig.getTpid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

      public @NonNull State1 build()
      A new State1 instance.
      Returns:
      A new State1 instance.