Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.node.meter.features

Class MeterFeaturesBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.meter.statistics.rev131111.node.meter.features.MeterFeaturesBuilder
@Generated("mdsal-binding-generator") public class MeterFeaturesBuilder extends Object
Class that builds MeterFeatures 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: 

   
     MeterFeatures createMeterFeatures(int fooXyzzy, int barBaz) {
         return new MeterFeaturesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MeterFeaturesBuilder

      public MeterFeaturesBuilder()
      Construct an empty builder.

    • MeterFeaturesBuilder

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

    • MeterFeaturesBuilder

      public MeterFeaturesBuilder(MeterFeatures arg)
      Construct a new builder initialized from specified MeterFeatures.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterFeatures from which the builder should be initialized

    • MeterFeaturesBuilder

      public MeterFeaturesBuilder(MeterFeatures base)
      Construct a builder initialized with state from specified MeterFeatures.
      Parameters:
      base - MeterFeatures 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

    • getMaxBands

      public org.opendaylight.yangtools.yang.common.Uint8 getMaxBands()
      Return current value associated with the property corresponding to MeterFeatures.getMaxBands().
      Returns:
      current value

    • getMaxColor

      public org.opendaylight.yangtools.yang.common.Uint8 getMaxColor()
      Return current value associated with the property corresponding to MeterFeatures.getMaxColor().
      Returns:
      current value

    • getMaxMeter

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getMaxMeter()
      Return current value associated with the property corresponding to MeterFeatures.getMaxMeter().
      Returns:
      current value

    • getMeterBandSupported

      public Set<MeterBand> getMeterBandSupported()
      Return current value associated with the property corresponding to MeterFeatures.getMeterBandSupported().
      Returns:
      current value

    • getMeterCapabilitiesSupported

      public Set<MeterCapability> getMeterCapabilitiesSupported()
      Return current value associated with the property corresponding to MeterFeatures.getMeterCapabilitiesSupported().
      Returns:
      current value

    • augmentation

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

    • setMaxBands

      public MeterFeaturesBuilder setMaxBands(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to MeterFeatures.getMaxBands() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaxColor

      public MeterFeaturesBuilder setMaxColor(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to MeterFeatures.getMaxColor() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaxMeter

      public MeterFeaturesBuilder setMaxMeter(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value)
      Set the property corresponding to MeterFeatures.getMaxMeter() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMeterBandSupported

      public MeterFeaturesBuilder setMeterBandSupported(Set<MeterBand> values)
      Set the property corresponding to MeterFeatures.getMeterBandSupported() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setMeterCapabilitiesSupported

      public MeterFeaturesBuilder setMeterCapabilitiesSupported(Set<MeterCapability> values)
      Set the property corresponding to MeterFeatures.getMeterCapabilitiesSupported() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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