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

Class SrCapabilitiesBuilder

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

   
     SrCapabilities createSrCapabilities(int fooXyzzy, int barBaz) {
         return new SrCapabilitiesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SrCapabilitiesBuilder

      public SrCapabilitiesBuilder()
      Construct an empty builder.

    • SrCapabilitiesBuilder

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

    • SrCapabilitiesBuilder

      public SrCapabilitiesBuilder(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

    • SrCapabilitiesBuilder

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

    • getMplsIpv4

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

    • getMplsIpv6

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

    • getRangeSize

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types.rev171204.Uint24 getRangeSize()
      Return current value associated with the property corresponding to SrCapabilitiesTlv.getRangeSize().
      Returns:
      current value

    • getSidLabelIndex

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

    • getSrIpv6

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

    • augmentation

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

    • setMplsIpv4

      public SrCapabilitiesBuilder setMplsIpv4(Boolean value)
      Set the property corresponding to SrCapabilitiesTlv.getMplsIpv4() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMplsIpv6

      public SrCapabilitiesBuilder setMplsIpv6(Boolean value)
      Set the property corresponding to SrCapabilitiesTlv.getMplsIpv6() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRangeSize

      public SrCapabilitiesBuilder setRangeSize(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.types.rev171204.Uint24 value)
      Set the property corresponding to SrCapabilitiesTlv.getRangeSize() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSidLabelIndex

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

    • setSrIpv6

      public SrCapabilitiesBuilder setSrIpv6(Boolean value)
      Set the property corresponding to SrCapabilitiesTlv.getSrIpv6() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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