java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequest.ItrRlocBuilder

@Generated("mdsal-binding-generator") public class ItrRlocBuilder extends Object
Class that builds ItrRloc 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:

   
     ItrRloc createItrRloc(int fooXyzzy, int barBaz) {
         return new ItrRlocBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • ItrRlocBuilder

      public ItrRlocBuilder()
      Construct an empty builder.
    • ItrRlocBuilder

      public ItrRlocBuilder(RlocContainer arg)
      Construct a new builder initialized from specified RlocContainer.
      Parameters:
      arg - RlocContainer from which the builder should be initialized
    • ItrRlocBuilder

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

      public ItrRlocKey key()
      Return current value associated with the property corresponding to ItrRloc.key().
      Returns:
      current value
    • getItrRlocId

      public String getItrRlocId()
      Return current value associated with the property corresponding to ItrRloc.getItrRlocId().
      Returns:
      current value
    • getRloc

      public Rloc getRloc()
      Return current value associated with the property corresponding to RlocContainer.getRloc().
      Returns:
      current value
    • augmentation

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

      public ItrRlocBuilder withKey(ItrRlocKey key)
      Set the key value corresponding to ItrRloc.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder
    • setItrRlocId

      public ItrRlocBuilder setItrRlocId(String value)
      Set the property corresponding to ItrRloc.getItrRlocId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setRloc

      public ItrRlocBuilder setRloc(Rloc value)
      Set the property corresponding to RlocContainer.getRloc() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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