Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.pcep.rev181109

Class ExplicitHops1Builder

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

   
     ExplicitHops1 createExplicitHops1(int fooXyzzy, int barBaz) {
         return new ExplicitHops1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    Constructors
    Constructor
    Description
    ExplicitHops1Builder()
    Construct an empty builder.
    ExplicitHops1Builder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.BasicExplicitRouteSubobjects arg)
    Construct a new builder initialized from specified BasicExplicitRouteSubobjects.
    ExplicitHops1Builder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.ExplicitRouteSubobjects arg)
    Construct a new builder initialized from specified ExplicitRouteSubobjects.
    ExplicitHops1Builder(ExplicitHops1 base)
    Construct a builder initialized with state from specified ExplicitHops1.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull ExplicitHops1
    build()
    A new ExplicitHops1 instance.
    void
    fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
    Set fields from given grouping argument.
    org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.basic.explicit.route.subobjects.SubobjectType
    getSubobjectType()
    Return current value associated with the property corresponding to BasicExplicitRouteSubobjects.getSubobjectType().
    ExplicitHops1Builder
    setSubobjectType(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.basic.explicit.route.subobjects.SubobjectType value)
    Set the property corresponding to BasicExplicitRouteSubobjects.getSubobjectType() to the specified value.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ExplicitHops1Builder

      public ExplicitHops1Builder()
      Construct an empty builder.

    • ExplicitHops1Builder

      public ExplicitHops1Builder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.ExplicitRouteSubobjects arg)
      Construct a new builder initialized from specified ExplicitRouteSubobjects.
      Parameters:
      arg - ExplicitRouteSubobjects from which the builder should be initialized

    • ExplicitHops1Builder

      public ExplicitHops1Builder(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.BasicExplicitRouteSubobjects arg)
      Construct a new builder initialized from specified BasicExplicitRouteSubobjects.
      Parameters:
      arg - BasicExplicitRouteSubobjects from which the builder should be initialized

    • ExplicitHops1Builder

      public ExplicitHops1Builder(ExplicitHops1 base)
      Construct a builder initialized with state from specified ExplicitHops1.
      Parameters:
      base - ExplicitHops1 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:
      • BasicExplicitRouteSubobjects
      • ExplicitRouteSubobjects
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • getSubobjectType

      public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.basic.explicit.route.subobjects.SubobjectType getSubobjectType()
      Return current value associated with the property corresponding to BasicExplicitRouteSubobjects.getSubobjectType().
      Returns:
      current value

    • setSubobjectType

      public ExplicitHops1Builder setSubobjectType(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.basic.explicit.route.subobjects.SubobjectType value)
      Set the property corresponding to BasicExplicitRouteSubobjects.getSubobjectType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

      public @NonNull ExplicitHops1 build()
      A new ExplicitHops1 instance.
      Returns:
      A new ExplicitHops1 instance.