Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.ntp.server.top.servers.server

Class StateBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.ntp.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(SystemNtpServerConfig arg)
      Construct a new builder initialized from specified SystemNtpServerConfig.
      Parameters:
      arg - SystemNtpServerConfig from which the builder should be initialized

    • StateBuilder

      public StateBuilder(SystemNtpServerState arg)
      Construct a new builder initialized from specified SystemNtpServerState.
      Parameters:
      arg - SystemNtpServerState 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 Host getAddress()
      Return current value associated with the property corresponding to SystemNtpServerConfig.getAddress().
      Returns:
      current value

    • getAssociationType

      public SystemNtpServerConfig.AssociationType getAssociationType()
      Return current value associated with the property corresponding to SystemNtpServerConfig.getAssociationType().
      Returns:
      current value

    • getIburst

      public Boolean getIburst()
      Return current value associated with the property corresponding to SystemNtpServerConfig.getIburst().
      Returns:
      current value

    • getOffset

      public org.opendaylight.yangtools.yang.common.Uint64 getOffset()
      Return current value associated with the property corresponding to SystemNtpServerState.getOffset().
      Returns:
      current value

    • getPollInterval

      public org.opendaylight.yangtools.yang.common.Uint32 getPollInterval()
      Return current value associated with the property corresponding to SystemNtpServerState.getPollInterval().
      Returns:
      current value

    • getPort

      public PortNumber getPort()
      Return current value associated with the property corresponding to SystemNtpServerConfig.getPort().
      Returns:
      current value

    • getPrefer

      public Boolean getPrefer()
      Return current value associated with the property corresponding to SystemNtpServerConfig.getPrefer().
      Returns:
      current value

    • getRootDelay

      public org.opendaylight.yangtools.yang.common.Uint32 getRootDelay()
      Return current value associated with the property corresponding to SystemNtpServerState.getRootDelay().
      Returns:
      current value

    • getRootDispersion

      public org.opendaylight.yangtools.yang.common.Uint64 getRootDispersion()
      Return current value associated with the property corresponding to SystemNtpServerState.getRootDispersion().
      Returns:
      current value

    • getStratum

      public org.opendaylight.yangtools.yang.common.Uint8 getStratum()
      Return current value associated with the property corresponding to SystemNtpServerState.getStratum().
      Returns:
      current value

    • getVersion

      public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
      Return current value associated with the property corresponding to SystemNtpServerConfig.getVersion().
      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(Host value)
      Set the property corresponding to SystemNtpServerConfig.getAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAssociationType

      public StateBuilder setAssociationType(SystemNtpServerConfig.AssociationType value)
      Set the property corresponding to SystemNtpServerConfig.getAssociationType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIburst

      public StateBuilder setIburst(Boolean value)
      Set the property corresponding to SystemNtpServerConfig.getIburst() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOffset

      public StateBuilder setOffset(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to SystemNtpServerState.getOffset() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPollInterval

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

    • setPort

      public StateBuilder setPort(PortNumber value)
      Set the property corresponding to SystemNtpServerConfig.getPort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPrefer

      public StateBuilder setPrefer(Boolean value)
      Set the property corresponding to SystemNtpServerConfig.getPrefer() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRootDelay

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

    • setRootDispersion

      public StateBuilder setRootDispersion(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to SystemNtpServerState.getRootDispersion() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setStratum

      public StateBuilder setStratum(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to SystemNtpServerState.getStratum() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersion

      public StateBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to SystemNtpServerConfig.getVersion() 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.