Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.terminal.rev181121.system.terminal.common.top

Class TerminalServersBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.terminal.rev181121.system.terminal.common.top.TerminalServersBuilder
@Generated("mdsal-binding-generator") public class TerminalServersBuilder extends Object
Class that builds TerminalServers 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: 

   
     TerminalServers createTerminalServers(int fooXyzzy, int barBaz) {
         return new TerminalServersBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TerminalServersBuilder

      public TerminalServersBuilder()
      Construct an empty builder.

    • TerminalServersBuilder

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

  • Method Details

    • empty

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

    • getConfig

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

    • getState

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

    • augmentation

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

    • setConfig

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

    • setState

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

    • addAugmentation

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