Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.prefix.state

Class SrRangeBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.prefix.state.SrRangeBuilder
@Generated("mdsal-binding-generator") public class SrRangeBuilder extends Object
Class that builds SrRange 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: 

   
     SrRange createSrRange(int fooXyzzy, int barBaz) {
         return new SrRangeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SrRangeBuilder

      public SrRangeBuilder()
      Construct an empty builder.

    • SrRangeBuilder

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

    • SrRangeBuilder

      public SrRangeBuilder(SrRange base)
      Construct a builder initialized with state from specified SrRange.
      Parameters:
      base - SrRange 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 SrRange empty()
      Get empty instance of SrRange.
      Returns:
      An empty SrRange

    • getInterArea

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

    • getRangeSize

      public org.opendaylight.yangtools.yang.common.Uint16 getRangeSize()
      Return current value associated with the property corresponding to RangeTlv.getRangeSize().
      Returns:
      current value

    • getSubTlvs

      public List<SubTlvs> getSubTlvs()
      Return current value associated with the property corresponding to RangeTlv.getSubTlvs().
      Returns:
      current value

    • augmentation

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

    • setInterArea

      public SrRangeBuilder setInterArea(Boolean value)
      Set the property corresponding to RangeTlv.getInterArea() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRangeSize

      public SrRangeBuilder setRangeSize(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to RangeTlv.getRangeSize() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSubTlvs

      public SrRangeBuilder setSubTlvs(List<SubTlvs> values)
      Set the property corresponding to RangeTlv.getSubTlvs() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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