Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.instance.id

Class InstanceIdBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.instance.id.InstanceIdBuilder
@Generated("mdsal-binding-generator") public class InstanceIdBuilder extends Object
Class that builds InstanceId 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: 

   
     InstanceId createInstanceId(int fooXyzzy, int barBaz) {
         return new InstanceIdBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • InstanceIdBuilder

      public InstanceIdBuilder()
      Construct an empty builder.

    • InstanceIdBuilder

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

  • Method Details

    • getAddress

      public SimpleAddress getAddress()
      Return current value associated with the property corresponding to InstanceId.getAddress().
      Returns:
      current value

    • getIid

      public InstanceIdType getIid()
      Return current value associated with the property corresponding to InstanceId.getIid().
      Returns:
      current value

    • getMaskLength

      public org.opendaylight.yangtools.yang.common.Uint8 getMaskLength()
      Return current value associated with the property corresponding to InstanceId.getMaskLength().
      Returns:
      current value

    • augmentation

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

    • setAddress

      public InstanceIdBuilder setAddress(SimpleAddress value)
      Set the property corresponding to InstanceId.getAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIid

      public InstanceIdBuilder setIid(InstanceIdType value)
      Set the property corresponding to InstanceId.getIid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaskLength

      public InstanceIdBuilder setMaskLength(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to InstanceId.getMaskLength() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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