Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.interfaces.top.interfaces._interface

Class StateBuilder

java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<State,StateBuilder>
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.interfaces.top.interfaces._interface.StateBuilder
All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator") public class StateBuilder extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<State,StateBuilder>
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:

  • Constructor Details

    • StateBuilder

      public StateBuilder()
      Construct an empty builder.

    • StateBuilder

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

    • StateBuilder

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

    • StateBuilder

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

    • StateBuilder

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

    • StateBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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

    • empty

      public static @NonNull State empty()
      Returns an empty State.
      Returns:
      an empty State

    • getAdminStatus

      @Deprecated(forRemoval=true) public InterfaceCommonState.AdminStatus getAdminStatus()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to InterfaceCommonState.getAdminStatus().
      Returns:
      current value

    • getCounters

      @Deprecated(forRemoval=true) public Counters getCounters()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to InterfaceCountersState.getCounters().
      Returns:
      current value

    • getDescription

      @Deprecated(forRemoval=true) public String getDescription()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to InterfaceCommonConfig.getDescription().
      Returns:
      current value

    • getEnabled

      @Deprecated(forRemoval=true) public Boolean getEnabled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to InterfaceCommonConfig.getEnabled().
      Returns:
      current value

    • getIfindex

      @Deprecated(forRemoval=true) public org.opendaylight.yangtools.yang.common.Uint32 getIfindex()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to InterfaceCommonState.getIfindex().
      Returns:
      current value

    • getLastChange

      @Deprecated(forRemoval=true) public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks getLastChange()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to InterfaceCommonState.getLastChange().
      Returns:
      current value

    • getMtu

      @Deprecated(forRemoval=true) public org.opendaylight.yangtools.yang.common.Uint16 getMtu()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to InterfacePhysConfig.getMtu().
      Returns:
      current value

    • getName

      @Deprecated(forRemoval=true) public String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to InterfaceCommonConfig.getName().
      Returns:
      current value

    • getOperStatus

      @Deprecated(forRemoval=true) public InterfaceCommonState.OperStatus getOperStatus()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to InterfaceCommonState.getOperStatus().
      Returns:
      current value

    • getType

      @Deprecated(forRemoval=true) public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.InterfaceType getType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not be generated in a future release
      Return current value associated with the property corresponding to InterfacePhysConfig.getType().
      Returns:
      current value

    • setAdminStatus

      public StateBuilder setAdminStatus(InterfaceCommonState.AdminStatus value)
      Set the property corresponding to InterfaceCommonState.getAdminStatus() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCounters

      public StateBuilder setCounters(Counters value)
      Set the property corresponding to InterfaceCountersState.getCounters() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setDescription

      public StateBuilder setDescription(String value)
      Set the property corresponding to InterfaceCommonConfig.getDescription() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEnabled

      public StateBuilder setEnabled(Boolean value)
      Set the property corresponding to InterfaceCommonConfig.getEnabled() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIfindex

      public StateBuilder setIfindex(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to InterfaceCommonState.getIfindex() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLastChange

      public StateBuilder setLastChange(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Timeticks value)
      Set the property corresponding to InterfaceCommonState.getLastChange() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMtu

      public StateBuilder setMtu(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to InterfacePhysConfig.getMtu() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

      public StateBuilder setName(String value)
      Set the property corresponding to InterfaceCommonConfig.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOperStatus

      public StateBuilder setOperStatus(InterfaceCommonState.OperStatus value)
      Set the property corresponding to InterfaceCommonState.getOperStatus() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setType

      public StateBuilder setType(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev180220.InterfaceType value)
      Set the property corresponding to InterfacePhysConfig.getType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

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