Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.system.rev200413.system.cpu.state

Class NiceBuilder

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

   
     Nice createNice(int fooXyzzy, int barBaz) {
         return new NiceBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NiceBuilder

      public NiceBuilder()
      Construct an empty builder.

    • NiceBuilder

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

    • NiceBuilder

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

    • NiceBuilder

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

    • NiceBuilder

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

    • getAvg

      public Percentage getAvg()
      Return current value associated with the property corresponding to AvgMinMaxInstantStatsPct.getAvg().
      Returns:
      current value

    • getInstant

      public Percentage getInstant()
      Return current value associated with the property corresponding to AvgMinMaxInstantStatsPct.getInstant().
      Returns:
      current value

    • getInterval

      public StatInterval getInterval()
      Return current value associated with the property corresponding to StatIntervalState.getInterval().
      Returns:
      current value

    • getMax

      public Percentage getMax()
      Return current value associated with the property corresponding to AvgMinMaxInstantStatsPct.getMax().
      Returns:
      current value

    • getMaxTime

      public Timeticks64 getMaxTime()
      Return current value associated with the property corresponding to MinMaxTime.getMaxTime().
      Returns:
      current value

    • getMin

      public Percentage getMin()
      Return current value associated with the property corresponding to AvgMinMaxInstantStatsPct.getMin().
      Returns:
      current value

    • getMinTime

      public Timeticks64 getMinTime()
      Return current value associated with the property corresponding to MinMaxTime.getMinTime().
      Returns:
      current value

    • augmentation

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

    • setAvg

      public NiceBuilder setAvg(Percentage value)
      Set the property corresponding to AvgMinMaxInstantStatsPct.getAvg() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setInstant

      public NiceBuilder setInstant(Percentage value)
      Set the property corresponding to AvgMinMaxInstantStatsPct.getInstant() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setInterval

      public NiceBuilder setInterval(StatInterval value)
      Set the property corresponding to StatIntervalState.getInterval() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMax

      public NiceBuilder setMax(Percentage value)
      Set the property corresponding to AvgMinMaxInstantStatsPct.getMax() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaxTime

      public NiceBuilder setMaxTime(Timeticks64 value)
      Set the property corresponding to MinMaxTime.getMaxTime() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMin

      public NiceBuilder setMin(Percentage value)
      Set the property corresponding to AvgMinMaxInstantStatsPct.getMin() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMinTime

      public NiceBuilder setMinTime(Timeticks64 value)
      Set the property corresponding to MinMaxTime.getMinTime() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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