Package org.opendaylight.yang.gen.v1.urn.lighty.gnmi.yang.storage.rev210331.gnmi.yang.models

Class GnmiYangModelBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.lighty.gnmi.yang.storage.rev210331.gnmi.yang.models.GnmiYangModelBuilder
@Generated("mdsal-binding-generator") public class GnmiYangModelBuilder extends Object
Class that builds GnmiYangModel 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: 

   
     GnmiYangModel createGnmiYangModel(int fooXyzzy, int barBaz) {
         return new GnmiYangModelBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • GnmiYangModelBuilder

      public GnmiYangModelBuilder()
      Construct an empty builder.

    • GnmiYangModelBuilder

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

    • GnmiYangModelBuilder

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

    • GnmiYangModelBuilder

      public GnmiYangModelBuilder(GnmiYangModel base)
      Construct a builder initialized with state from specified GnmiYangModel.
      Parameters:
      base - GnmiYangModel 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 GnmiYangModelKey key()
      Return current value associated with the property corresponding to GnmiYangModel.key().
      Returns:
      current value

    • getBody

      public String getBody()
      Return current value associated with the property corresponding to YangModel.getBody().
      Returns:
      current value

    • getName

      public String getName()
      Return current value associated with the property corresponding to YangModelNameVersion.getName().
      Returns:
      current value

    • getVersion

      public ModuleVersionType getVersion()
      Return current value associated with the property corresponding to YangModelNameVersion.getVersion().
      Returns:
      current value

    • augmentation

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

    • setBody

      public GnmiYangModelBuilder setBody(String value)
      Set the property corresponding to YangModel.getBody() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

      public GnmiYangModelBuilder setName(String value)
      Set the property corresponding to YangModelNameVersion.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersion

      public GnmiYangModelBuilder setVersion(ModuleVersionType value)
      Set the property corresponding to YangModelNameVersion.getVersion() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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