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

Class MeterMessageBuilder

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

   
     MeterMessage createMeterMessage(int fooXyzzy, int barBaz) {
         return new MeterMessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MeterMessageBuilder

      public MeterMessageBuilder()
      Construct an empty builder.

    • MeterMessageBuilder

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

    • MeterMessageBuilder

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

    • MeterMessageBuilder

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

    • getBarrier

      public Boolean getBarrier()
      Return current value associated with the property corresponding to Meter.getBarrier().
      Returns:
      current value

    • getCommand

      public MeterModCommand getCommand()
      Return current value associated with the property corresponding to MeterMessage.getCommand().
      Returns:
      current value

    • getContainerName

      public String getContainerName()
      Return current value associated with the property corresponding to Meter.getContainerName().
      Returns:
      current value

    • getFlags

      public MeterFlags getFlags()
      Return current value associated with the property corresponding to Meter.getFlags().
      Returns:
      current value

    • getMeterBandHeaders

      public MeterBandHeaders getMeterBandHeaders()
      Return current value associated with the property corresponding to Meter.getMeterBandHeaders().
      Returns:
      current value

    • getMeterId

      public MeterId getMeterId()
      Return current value associated with the property corresponding to Meter.getMeterId().
      Returns:
      current value

    • getMeterName

      public String getMeterName()
      Return current value associated with the property corresponding to Meter.getMeterName().
      Returns:
      current value

    • getVersion

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

    • getXid

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

    • augmentation

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

    • setBarrier

      public MeterMessageBuilder setBarrier(Boolean value)
      Set the property corresponding to Meter.getBarrier() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCommand

      public MeterMessageBuilder setCommand(MeterModCommand value)
      Set the property corresponding to MeterMessage.getCommand() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setContainerName

      public MeterMessageBuilder setContainerName(String value)
      Set the property corresponding to Meter.getContainerName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setFlags

      public MeterMessageBuilder setFlags(MeterFlags value)
      Set the property corresponding to Meter.getFlags() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMeterBandHeaders

      public MeterMessageBuilder setMeterBandHeaders(MeterBandHeaders value)
      Set the property corresponding to Meter.getMeterBandHeaders() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMeterId

      public MeterMessageBuilder setMeterId(MeterId value)
      Set the property corresponding to Meter.getMeterId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMeterName

      public MeterMessageBuilder setMeterName(String value)
      Set the property corresponding to Meter.getMeterName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersion

      public MeterMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to OfHeader.getVersion() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setXid

      public MeterMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to OfHeader.getXid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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