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

Class AddMeterInputBuilder

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

   
     AddMeterInput createAddMeterInput(int fooXyzzy, int barBaz) {
         return new AddMeterInputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • AddMeterInputBuilder

      public AddMeterInputBuilder()
      Construct an empty builder.

    • AddMeterInputBuilder

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

    • AddMeterInputBuilder

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

    • AddMeterInputBuilder

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

    • AddMeterInputBuilder

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

    • AddMeterInputBuilder

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

    • 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

    • getMeterRef

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

    • getNode

      public NodeRef getNode()
      Return current value associated with the property corresponding to NodeContextRef.getNode().
      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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddMeterInput>> 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 AddMeterInputBuilder setBarrier(Boolean value)
      Set the property corresponding to Meter.getBarrier() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setContainerName

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

    • setFlags

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

    • setMeterBandHeaders

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

    • setMeterId

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

    • setMeterName

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

    • setMeterRef

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

    • setNode

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

    • setTransactionUri

      public AddMeterInputBuilder 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

    • addAugmentation

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