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

Class UpdateMeterInputBuilder

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

   
     UpdateMeterInput createUpdateMeterInput(int fooXyzzy, int barBaz) {
         return new UpdateMeterInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • UpdateMeterInputBuilder

      public UpdateMeterInputBuilder()
      Construct an empty builder.

    • UpdateMeterInputBuilder

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

    • UpdateMeterInputBuilder

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

    • UpdateMeterInputBuilder

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

    • UpdateMeterInputBuilder

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

    • getMeterRef

      public MeterRef getMeterRef()
      Return current value associated with the property corresponding to UpdateMeterInput.getMeterRef().
      Returns:
      current value

    • getNode

      public NodeRef getNode()
      Return current value associated with the property corresponding to NodeContextRef.getNode().
      Returns:
      current value

    • getOriginalMeter

      public OriginalMeter getOriginalMeter()
      Return current value associated with the property corresponding to MeterUpdate.getOriginalMeter().
      Returns:
      current value

    • getTransactionUri

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()
      Return current value associated with the property corresponding to TransactionMetadata.getTransactionUri().
      Returns:
      current value

    • getUpdatedMeter

      public UpdatedMeter getUpdatedMeter()
      Return current value associated with the property corresponding to MeterUpdate.getUpdatedMeter().
      Returns:
      current value

    • augmentation

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

    • setMeterRef

      public UpdateMeterInputBuilder setMeterRef(MeterRef value)
      Set the property corresponding to UpdateMeterInput.getMeterRef() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNode

      public UpdateMeterInputBuilder setNode(NodeRef value)
      Set the property corresponding to NodeContextRef.getNode() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setOriginalMeter

      public UpdateMeterInputBuilder setOriginalMeter(OriginalMeter value)
      Set the property corresponding to MeterUpdate.getOriginalMeter() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTransactionUri

      public UpdateMeterInputBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
      Set the property corresponding to TransactionMetadata.getTransactionUri() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setUpdatedMeter

      public UpdateMeterInputBuilder setUpdatedMeter(UpdatedMeter value)
      Set the property corresponding to MeterUpdate.getUpdatedMeter() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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