Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.tspec.object

Class TspecObjectBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.tspec.object.TspecObjectBuilder
@Generated("mdsal-binding-generator") public class TspecObjectBuilder extends Object
Class that builds TspecObject 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: 

   
     TspecObject createTspecObject(int fooXyzzy, int barBaz) {
         return new TspecObjectBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TspecObjectBuilder

      public TspecObjectBuilder()
      Construct an empty builder.

    • TspecObjectBuilder

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

    • TspecObjectBuilder

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

    • empty

      public static @NonNull TspecObject empty()
      Get empty instance of TspecObject.
      Returns:
      An empty TspecObject

    • getMaximumPacketSize

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

    • getMinimumPolicedUnit

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

    • getPeakDataRate

      public Float32 getPeakDataRate()
      Return current value associated with the property corresponding to TspecObject.getPeakDataRate().
      Returns:
      current value

    • getTokenBucketRate

      public Float32 getTokenBucketRate()
      Return current value associated with the property corresponding to TspecObject.getTokenBucketRate().
      Returns:
      current value

    • getTokenBucketSize

      public Float32 getTokenBucketSize()
      Return current value associated with the property corresponding to TspecObject.getTokenBucketSize().
      Returns:
      current value

    • augmentation

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

    • setMaximumPacketSize

      public TspecObjectBuilder setMaximumPacketSize(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to TspecObject.getMaximumPacketSize() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMinimumPolicedUnit

      public TspecObjectBuilder setMinimumPolicedUnit(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to TspecObject.getMinimumPolicedUnit() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPeakDataRate

      public TspecObjectBuilder setPeakDataRate(Float32 value)
      Set the property corresponding to TspecObject.getPeakDataRate() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTokenBucketRate

      public TspecObjectBuilder setTokenBucketRate(Float32 value)
      Set the property corresponding to TspecObject.getTokenBucketRate() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTokenBucketSize

      public TspecObjectBuilder setTokenBucketSize(Float32 value)
      Set the property corresponding to TspecObject.getTokenBucketSize() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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