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

Class ServerBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.ntp.server.top.servers.ServerBuilder
@Generated("mdsal-binding-generator") public class ServerBuilder extends Object
Class that builds Server 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: 

   
     Server createServer(int fooXyzzy, int barBaz) {
         return new ServerBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ServerBuilder

      public ServerBuilder()
      Construct an empty builder.

    • ServerBuilder

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

  • Method Details

    • key

      public ServerKey key()
      Return current value associated with the property corresponding to Server.key().
      Returns:
      current value

    • getAddress

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

    • getConfig

      public Config getConfig()
      Return current value associated with the property corresponding to Server.getConfig().
      Returns:
      current value

    • getState

      public State getState()
      Return current value associated with the property corresponding to Server.getState().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Server>> 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

    • withKey

      public ServerBuilder withKey(ServerKey key)
      Set the key value corresponding to Server.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setAddress

      public ServerBuilder setAddress(Host value)
      Set the property corresponding to Server.getAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConfig

      public ServerBuilder setConfig(Config value)
      Set the property corresponding to Server.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setState

      public ServerBuilder setState(State value)
      Set the property corresponding to Server.getState() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public ServerBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Server> 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 ServerBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Server>> 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 Server build()
      A new Server instance.
      Returns:
      A new Server instance.