Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.drop._case

Class MeterBandDropBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.meter.band.header.meter.band.meter.band.drop._case.MeterBandDropBuilder
@Generated("mdsal-binding-generator") public class MeterBandDropBuilder extends Object
Class that builds MeterBandDrop 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: 

   
     MeterBandDrop createMeterBandDrop(int fooXyzzy, int barBaz) {
         return new MeterBandDropBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MeterBandDropBuilder

      public MeterBandDropBuilder()
      Construct an empty builder.

    • MeterBandDropBuilder

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

    • MeterBandDropBuilder

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

    • getBurstSize

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

    • getRate

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

    • getType

      public MeterBandType getType()
      Return current value associated with the property corresponding to MeterBandCommons.getType().
      Returns:
      current value

    • augmentation

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

    • setBurstSize

      public MeterBandDropBuilder setBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to MeterBandCommons.getBurstSize() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRate

      public MeterBandDropBuilder setRate(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to MeterBandCommons.getRate() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setType

      public MeterBandDropBuilder setType(MeterBandType value)
      Set the property corresponding to MeterBandCommons.getType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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