Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers

Class MeterBandHeaderBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers.MeterBandHeaderBuilder
@Generated("mdsal-binding-generator") public class MeterBandHeaderBuilder extends Object
Class that builds MeterBandHeader 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: 

   
     MeterBandHeader createMeterBandHeader(int fooXyzzy, int barBaz) {
         return new MeterBandHeaderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MeterBandHeaderBuilder

      public MeterBandHeaderBuilder()
      Construct an empty builder.

    • MeterBandHeaderBuilder

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

    • MeterBandHeaderBuilder

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

    • getBandBurstSize

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

    • getBandId

      public BandId getBandId()
      Return current value associated with the property corresponding to MeterBandHeader.getBandId().
      Returns:
      current value

    • getBandRate

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

    • getBandType

      public BandType getBandType()
      Return current value associated with the property corresponding to BandType.getBandType().
      Returns:
      current value

    • getMeterBandTypes

      public MeterBandTypes getMeterBandTypes()
      Return current value associated with the property corresponding to MeterBandHeader.getMeterBandTypes().
      Returns:
      current value

    • augmentation

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

    • setBandBurstSize

      public MeterBandHeaderBuilder setBandBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to MeterBandHeader.getBandBurstSize() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBandId

      public MeterBandHeaderBuilder setBandId(BandId value)
      Set the property corresponding to MeterBandHeader.getBandId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBandRate

      public MeterBandHeaderBuilder setBandRate(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to MeterBandHeader.getBandRate() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setBandType

      public MeterBandHeaderBuilder setBandType(BandType value)
      Set the property corresponding to BandType.getBandType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMeterBandTypes

      public MeterBandHeaderBuilder setMeterBandTypes(MeterBandTypes value)
      Set the property corresponding to MeterBandHeader.getMeterBandTypes() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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