Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.sr.pce.capability.tlv

Class SrPceCapabilityBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.segment.routing.rev200720.sr.pce.capability.tlv.SrPceCapabilityBuilder
@Generated("mdsal-binding-generator") public class SrPceCapabilityBuilder extends Object
Class that builds SrPceCapability 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: 

   
     SrPceCapability createSrPceCapability(int fooXyzzy, int barBaz) {
         return new SrPceCapabilityBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SrPceCapabilityBuilder

      public SrPceCapabilityBuilder()
      Construct an empty builder.

    • SrPceCapabilityBuilder

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

    • SrPceCapabilityBuilder

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

    • getMsd

      public org.opendaylight.yangtools.yang.common.Uint8 getMsd()
      Return current value associated with the property corresponding to SrPceCapability.getMsd().
      Returns:
      current value

    • getNFlag

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

    • getXFlag

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

    • augmentation

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

    • setMsd

      public SrPceCapabilityBuilder setMsd(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to SrPceCapability.getMsd() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNFlag

      public SrPceCapabilityBuilder setNFlag(Boolean value)
      Set the property corresponding to SrPceCapability.getNFlag() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setXFlag

      public SrPceCapabilityBuilder setXFlag(Boolean value)
      Set the property corresponding to SrPceCapability.getXFlag() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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