Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.explicit.route.object.ero

Class SubobjectBuilder

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

   
     Subobject createSubobject(int fooXyzzy, int barBaz) {
         return new SubobjectBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • SubobjectBuilder

      public SubobjectBuilder()
      Construct an empty builder.

    • SubobjectBuilder

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

    • SubobjectBuilder

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

    • SubobjectBuilder

      public SubobjectBuilder(Subobject base)
      Construct a builder initialized with state from specified Subobject.
      Parameters:
      base - Subobject 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

    • getLoose

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

    • getSubobjectType

      public SubobjectType getSubobjectType()
      Return current value associated with the property corresponding to BasicExplicitRouteSubobjects.getSubobjectType().
      Returns:
      current value

    • augmentation

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

    • setLoose

      public SubobjectBuilder setLoose(Boolean value)
      Set the property corresponding to Subobject.getLoose() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSubobjectType

      public SubobjectBuilder setSubobjectType(SubobjectType value)
      Set the property corresponding to BasicExplicitRouteSubobjects.getSubobjectType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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