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

Class NtpKeyBuilder

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

   
     NtpKey createNtpKey(int fooXyzzy, int barBaz) {
         return new NtpKeyBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NtpKeyBuilder

      public NtpKeyBuilder()
      Construct an empty builder.

    • NtpKeyBuilder

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

  • Method Details

    • key

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

    • getConfig

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

    • getKeyId

      public org.opendaylight.yangtools.yang.common.Uint16 getKeyId()
      Return current value associated with the property corresponding to NtpKey.getKeyId().
      Returns:
      current value

    • getState

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

    • augmentation

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

    • setConfig

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

    • setKeyId

      public NtpKeyBuilder setKeyId(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to NtpKey.getKeyId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setState

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

    • addAugmentation

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