Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.svec.object

Class SvecBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.svec.object.SvecBuilder
@Generated("mdsal-binding-generator") public class SvecBuilder extends Object
Class that builds Svec 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: 

   
     Svec createSvec(int fooXyzzy, int barBaz) {
         return new SvecBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SvecBuilder

      public SvecBuilder()
      Construct an empty builder.

    • SvecBuilder

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

    • SvecBuilder

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

    • SvecBuilder

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

    • getIgnore

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

    • getLinkDirectionDiverse

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

    • getLinkDiverse

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

    • getNodeDiverse

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

    • getPartialPathDiverse

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

    • getProcessingRule

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

    • getRequestsIds

      public Set<RequestId> getRequestsIds()
      Return current value associated with the property corresponding to Svec.getRequestsIds().
      Returns:
      current value

    • getSrlgDiverse

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

    • augmentation

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

    • setIgnore

      public SvecBuilder setIgnore(Boolean value)
      Set the property corresponding to ObjectHeader.getIgnore() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLinkDirectionDiverse

      public SvecBuilder setLinkDirectionDiverse(Boolean value)
      Set the property corresponding to Svec.getLinkDirectionDiverse() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLinkDiverse

      public SvecBuilder setLinkDiverse(Boolean value)
      Set the property corresponding to Svec.getLinkDiverse() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNodeDiverse

      public SvecBuilder setNodeDiverse(Boolean value)
      Set the property corresponding to Svec.getNodeDiverse() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPartialPathDiverse

      public SvecBuilder setPartialPathDiverse(Boolean value)
      Set the property corresponding to Svec.getPartialPathDiverse() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setProcessingRule

      public SvecBuilder setProcessingRule(Boolean value)
      Set the property corresponding to ObjectHeader.getProcessingRule() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRequestsIds

      public SvecBuilder setRequestsIds(Set<RequestId> values)
      Set the property corresponding to Svec.getRequestsIds() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setSrlgDiverse

      public SvecBuilder setSrlgDiverse(Boolean value)
      Set the property corresponding to Svec.getSrlgDiverse() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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