Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message

Class SvecBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.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(SvecObject arg)
      Construct a new builder initialized from specified SvecObject.
      Parameters:
      arg - SvecObject from which the builder should be initialized

    • SvecBuilder

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

    • SvecBuilder

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

    • SvecBuilder

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

    • SvecBuilder

      public SvecBuilder(VendorInformationObjects arg)
      Construct a new builder initialized from specified VendorInformationObjects.
      Parameters:
      arg - VendorInformationObjects 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

    • getGc

      public Gc getGc()
      Return current value associated with the property corresponding to GcObject.getGc().
      Returns:
      current value

    • getMetric

      public List<Metric> getMetric()
      Return current value associated with the property corresponding to Svec.getMetric().
      Returns:
      current value

    • getOf

      public Of getOf()
      Return current value associated with the property corresponding to OfObject.getOf().
      Returns:
      current value

    • getSvec

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

    • getVendorInformationObject

      public List<VendorInformationObject> getVendorInformationObject()
      Return current value associated with the property corresponding to VendorInformationObjects.getVendorInformationObject().
      Returns:
      current value

    • getXro

      public Xro getXro()
      Return current value associated with the property corresponding to ExcludeRouteObject.getXro().
      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

    • setGc

      public SvecBuilder setGc(Gc value)
      Set the property corresponding to GcObject.getGc() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMetric

      public SvecBuilder setMetric(List<Metric> values)
      Set the property corresponding to Svec.getMetric() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setOf

      public SvecBuilder setOf(Of value)
      Set the property corresponding to OfObject.getOf() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSvec

      public SvecBuilder setSvec(Svec value)
      Set the property corresponding to SvecObject.getSvec() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVendorInformationObject

      public SvecBuilder setVendorInformationObject(List<VendorInformationObject> values)
      Set the property corresponding to VendorInformationObjects.getVendorInformationObject() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setXro

      public SvecBuilder setXro(Xro value)
      Set the property corresponding to ExcludeRouteObject.getXro() 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.