Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.server.top.servers.server

Class StateBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.server.top.servers.server.StateBuilder
@Generated("mdsal-binding-generator") public class StateBuilder extends Object
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(AaaServerConfig arg)
      Construct a new builder initialized from specified AaaServerConfig.
      Parameters:
      arg - AaaServerConfig from which the builder should be initialized

    • StateBuilder

      public StateBuilder(AaaServerState arg)
      Construct a new builder initialized from specified AaaServerState.
      Parameters:
      arg - AaaServerState 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.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

    • empty

      public static @NonNull State empty()
      Get empty instance of State.
      Returns:
      An empty State

    • getAddress

      public IpAddress getAddress()
      Return current value associated with the property corresponding to AaaServerConfig.getAddress().
      Returns:
      current value

    • getConnectionAborts

      public Counter64 getConnectionAborts()
      Return current value associated with the property corresponding to AaaServerState.getConnectionAborts().
      Returns:
      current value

    • getConnectionCloses

      public Counter64 getConnectionCloses()
      Return current value associated with the property corresponding to AaaServerState.getConnectionCloses().
      Returns:
      current value

    • getConnectionFailures

      public Counter64 getConnectionFailures()
      Return current value associated with the property corresponding to AaaServerState.getConnectionFailures().
      Returns:
      current value

    • getConnectionOpens

      public Counter64 getConnectionOpens()
      Return current value associated with the property corresponding to AaaServerState.getConnectionOpens().
      Returns:
      current value

    • getConnectionTimeouts

      public Counter64 getConnectionTimeouts()
      Return current value associated with the property corresponding to AaaServerState.getConnectionTimeouts().
      Returns:
      current value

    • getErrorsReceived

      public Counter64 getErrorsReceived()
      Return current value associated with the property corresponding to AaaServerState.getErrorsReceived().
      Returns:
      current value

    • getMessagesReceived

      public Counter64 getMessagesReceived()
      Return current value associated with the property corresponding to AaaServerState.getMessagesReceived().
      Returns:
      current value

    • getMessagesSent

      public Counter64 getMessagesSent()
      Return current value associated with the property corresponding to AaaServerState.getMessagesSent().
      Returns:
      current value

    • getName

      public String getName()
      Return current value associated with the property corresponding to AaaServerConfig.getName().
      Returns:
      current value

    • getTimeout

      public org.opendaylight.yangtools.yang.common.Uint16 getTimeout()
      Return current value associated with the property corresponding to AaaServerConfig.getTimeout().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<State>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      Parameters:
      augmentationType - augmentation type class
      Returns:
      Augmentation object from this builder, or null if not present
      Throws:
      NullPointerException - if augmentType is null

    • setAddress

      public StateBuilder setAddress(IpAddress value)
      Set the property corresponding to AaaServerConfig.getAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConnectionAborts

      public StateBuilder setConnectionAborts(Counter64 value)
      Set the property corresponding to AaaServerState.getConnectionAborts() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConnectionCloses

      public StateBuilder setConnectionCloses(Counter64 value)
      Set the property corresponding to AaaServerState.getConnectionCloses() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConnectionFailures

      public StateBuilder setConnectionFailures(Counter64 value)
      Set the property corresponding to AaaServerState.getConnectionFailures() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConnectionOpens

      public StateBuilder setConnectionOpens(Counter64 value)
      Set the property corresponding to AaaServerState.getConnectionOpens() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConnectionTimeouts

      public StateBuilder setConnectionTimeouts(Counter64 value)
      Set the property corresponding to AaaServerState.getConnectionTimeouts() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setErrorsReceived

      public StateBuilder setErrorsReceived(Counter64 value)
      Set the property corresponding to AaaServerState.getErrorsReceived() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMessagesReceived

      public StateBuilder setMessagesReceived(Counter64 value)
      Set the property corresponding to AaaServerState.getMessagesReceived() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMessagesSent

      public StateBuilder setMessagesSent(Counter64 value)
      Set the property corresponding to AaaServerState.getMessagesSent() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

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

    • setTimeout

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

    • 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 @NonNull State build()
      A new State instance.
      Returns:
      A new State instance.