Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.node.attributes.ospf.node.attributes.router.type

Class AbrBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.node.attributes.ospf.node.attributes.router.type.AbrBuilder
@Generated("mdsal-binding-generator") public class AbrBuilder extends Object
Class that builds Abr 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: 

   
     Abr createAbr(int fooXyzzy, int barBaz) {
         return new AbrBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

  • Method Summary

    Modifier and Type
    Method
    Description
    AbrBuilder
    addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Abr> augmentation)
    Add an augmentation to this builder's product.
    <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Abr>>
    E$$
    augmentation(Class<E$$> augmentationType)
    Return the specified augmentation, if it is present in this builder.
    @NonNull Abr
    build()
    A new Abr instance.
    org.opendaylight.yangtools.yang.common.Empty
    getAbr()
    Return current value associated with the property corresponding to Abr.getAbr().
    AbrBuilder
    removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Abr>> augmentationType)
    Remove an augmentation from this builder's product.
    AbrBuilder
    setAbr(org.opendaylight.yangtools.yang.common.Empty value)
    Set the property corresponding to Abr.getAbr() to the specified value.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AbrBuilder

      public AbrBuilder()
      Construct an empty builder.

    • AbrBuilder

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

  • Method Details

    • getAbr

      public org.opendaylight.yangtools.yang.common.Empty getAbr()
      Return current value associated with the property corresponding to Abr.getAbr().
      Returns:
      current value

    • augmentation

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

    • setAbr

      public AbrBuilder setAbr(org.opendaylight.yangtools.yang.common.Empty value)
      Set the property corresponding to Abr.getAbr() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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