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

Class NtpBuilder

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

   
     Ntp createNtp(int fooXyzzy, int barBaz) {
         return new NtpBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NtpBuilder

      public NtpBuilder()
      Construct an empty builder.

    • NtpBuilder

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

    • NtpBuilder

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

    • NtpBuilder

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

    • getConfig

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

    • getNtpKeys

      public NtpKeys getNtpKeys()
      Return current value associated with the property corresponding to SystemNtpAuthKeysTop.getNtpKeys().
      Returns:
      current value

    • getServers

      public Servers getServers()
      Return current value associated with the property corresponding to SystemNtpServerTop.getServers().
      Returns:
      current value

    • getState

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ntp>> 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 NtpBuilder setConfig(Config value)
      Set the property corresponding to Ntp.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNtpKeys

      public NtpBuilder setNtpKeys(NtpKeys value)
      Set the property corresponding to SystemNtpAuthKeysTop.getNtpKeys() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setServers

      public NtpBuilder setServers(Servers value)
      Set the property corresponding to SystemNtpServerTop.getServers() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setState

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

    • addAugmentation

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