Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev220720.vertex

Class SrgbBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev220720.vertex.SrgbBuilder
@Generated("mdsal-binding-generator") public class SrgbBuilder extends Object
Class that builds Srgb 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: 

   
     Srgb createSrgb(int fooXyzzy, int barBaz) {
         return new SrgbBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SrgbBuilder

      public SrgbBuilder()
      Construct an empty builder.

    • SrgbBuilder

      public SrgbBuilder(Srgb arg)
      Construct a new builder initialized from specified Srgb.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev220720.Srgb from which the builder should be initialized

    • SrgbBuilder

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

    • getLowerBound

      public org.opendaylight.yangtools.yang.common.Uint32 getLowerBound()
      Return current value associated with the property corresponding to Srgb.getLowerBound().
      Returns:
      current value

    • getRangeSize

      public org.opendaylight.yangtools.yang.common.Uint32 getRangeSize()
      Return current value associated with the property corresponding to Srgb.getRangeSize().
      Returns:
      current value

    • augmentation

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

    • setLowerBound

      public SrgbBuilder setLowerBound(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Srgb.getLowerBound() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRangeSize

      public SrgbBuilder setRangeSize(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Srgb.getRangeSize() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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