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

Class SrPrefixBuilder

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

   
     SrPrefix createSrPrefix(int fooXyzzy, int barBaz) {
         return new SrPrefixBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SrPrefixBuilder

      public SrPrefixBuilder()
      Construct an empty builder.

    • SrPrefixBuilder

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

    • SrPrefixBuilder

      public SrPrefixBuilder(SidLabelIndex arg)
      Construct a new builder initialized from specified SidLabelIndex.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.SidLabelIndex from which the builder should be initialized

    • SrPrefixBuilder

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

    • getAlgorithm

      public Algorithm getAlgorithm()
      Return current value associated with the property corresponding to PrefixSidTlv.getAlgorithm().
      Returns:
      current value

    • getFlags

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

    • getSidLabelIndex

      public SidLabelIndex getSidLabelIndex()
      Return current value associated with the property corresponding to SidLabelIndex.getSidLabelIndex().
      Returns:
      current value

    • augmentation

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

    • setAlgorithm

      public SrPrefixBuilder setAlgorithm(Algorithm value)
      Set the property corresponding to PrefixSidTlv.getAlgorithm() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setFlags

      public SrPrefixBuilder setFlags(Flags value)
      Set the property corresponding to PrefixSidTlv.getFlags() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSidLabelIndex

      public SrPrefixBuilder setSidLabelIndex(SidLabelIndex value)
      Set the property corresponding to SidLabelIndex.getSidLabelIndex() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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