Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.logging.rev181121.logging.remote.top.remote.servers

Class RemoteServerBuilder

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

   
     RemoteServer createRemoteServer(int fooXyzzy, int barBaz) {
         return new RemoteServerBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • RemoteServerBuilder

      public RemoteServerBuilder()
      Construct an empty builder.

    • RemoteServerBuilder

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

    • RemoteServerBuilder

      public RemoteServerBuilder(RemoteServer base)
      Construct a builder initialized with state from specified RemoteServer.
      Parameters:
      base - RemoteServer 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

    • key

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

    • getConfig

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

    • getHost

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

    • getSelectors

      public Selectors getSelectors()
      Return current value associated with the property corresponding to LoggingSelectorsTop.getSelectors().
      Returns:
      current value

    • getState

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RemoteServer>> 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 RemoteServerBuilder withKey(RemoteServerKey key)
      Set the key value corresponding to RemoteServer.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setConfig

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

    • setHost

      public RemoteServerBuilder setHost(Host value)
      Set the property corresponding to RemoteServer.getHost() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSelectors

      public RemoteServerBuilder setSelectors(Selectors value)
      Set the property corresponding to LoggingSelectorsTop.getSelectors() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setState

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

    • addAugmentation

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