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

Class ReportedHops1Builder

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

   
     ReportedHops1 createReportedHops1(int fooXyzzy, int barBaz) {
         return new ReportedHops1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ReportedHops1Builder

      public ReportedHops1Builder()
      Construct an empty builder.

    • ReportedHops1Builder

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

    • ReportedHops1Builder

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

    • getProtectionAvailable

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

    • getProtectionInUse

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

    • getSubobjectType

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

    • setProtectionAvailable

      public ReportedHops1Builder setProtectionAvailable(Boolean value)
      Set the property corresponding to RecordRouteSubobjects.getProtectionAvailable() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setProtectionInUse

      public ReportedHops1Builder setProtectionInUse(Boolean value)
      Set the property corresponding to RecordRouteSubobjects.getProtectionInUse() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSubobjectType

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

    • build

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