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

Class LoggingBuilder

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

   
     Logging createLogging(int fooXyzzy, int barBaz) {
         return new LoggingBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • LoggingBuilder

      public LoggingBuilder()
      Construct an empty builder.

    • LoggingBuilder

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

    • LoggingBuilder

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

    • LoggingBuilder

      public LoggingBuilder(Logging base)
      Construct a builder initialized with state from specified Logging.
      Parameters:
      base - Logging 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 Logging empty()
      Get empty instance of Logging.
      Returns:
      An empty Logging

    • getConsole

      public Console getConsole()
      Return current value associated with the property corresponding to LoggingConsoleTop.getConsole().
      Returns:
      current value

    • getRemoteServers

      public RemoteServers getRemoteServers()
      Return current value associated with the property corresponding to LoggingRemoteTop.getRemoteServers().
      Returns:
      current value

    • augmentation

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

    • setConsole

      public LoggingBuilder setConsole(Console value)
      Set the property corresponding to LoggingConsoleTop.getConsole() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRemoteServers

      public LoggingBuilder setRemoteServers(RemoteServers value)
      Set the property corresponding to LoggingRemoteTop.getRemoteServers() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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