Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.detour.object.detour.object.ipv4.detour.object

Class PlrBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.detour.object.detour.object.ipv4.detour.object.PlrBuilder
@Generated("mdsal-binding-generator") public class PlrBuilder extends Object
Class that builds Plr 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: 

   
     Plr createPlr(int fooXyzzy, int barBaz) {
         return new PlrBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of Plr, 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
    PlrBuilder()
    Construct an empty builder.
    PlrBuilder(Plr base)
    Construct a builder initialized with state from specified Plr.

  • Method Summary

    Modifier and Type
    Method
    Description
    PlrBuilder
    addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Plr> augmentation)
    Add an augmentation to this builder's product.
    <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Plr>>
    E$$
    augmentation(Class<E$$> augmentationType)
    Return the specified augmentation, if it is present in this builder.
    @NonNull Plr
    build()
    A new Plr instance.
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
    getAvoidNode()
    Return current value associated with the property corresponding to Plr.getAvoidNode().
    org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
    getPlrId()
    Return current value associated with the property corresponding to Plr.getPlrId().
    PlrBuilder
    removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Plr>> augmentationType)
    Remove an augmentation from this builder's product.
    PlrBuilder
    setAvoidNode(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
    Set the property corresponding to Plr.getAvoidNode() to the specified value.
    PlrBuilder
    setPlrId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
    Set the property corresponding to Plr.getPlrId() to the specified value.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PlrBuilder

      public PlrBuilder()
      Construct an empty builder.

    • PlrBuilder

      public PlrBuilder(Plr base)
      Construct a builder initialized with state from specified Plr.
      Parameters:
      base - Plr from which the builder should be initialized

  • Method Details

    • getAvoidNode

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getAvoidNode()
      Return current value associated with the property corresponding to Plr.getAvoidNode().
      Returns:
      current value

    • getPlrId

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getPlrId()
      Return current value associated with the property corresponding to Plr.getPlrId().
      Returns:
      current value

    • augmentation

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

    • setAvoidNode

      public PlrBuilder setAvoidNode(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
      Set the property corresponding to Plr.getAvoidNode() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPlrId

      public PlrBuilder setPlrId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
      Set the property corresponding to Plr.getPlrId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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