Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.explicit.locator.path.explicit.locator.path

Class HopBuilder

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

   
     Hop createHop(int fooXyzzy, int barBaz) {
         return new HopBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • HopBuilder

      public HopBuilder()
      Construct an empty builder.

    • HopBuilder

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

  • Method Details

    • key

      public HopKey key()
      Return current value associated with the property corresponding to Hop.key().
      Returns:
      current value

    • getAddress

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

    • getHopId

      public String getHopId()
      Return current value associated with the property corresponding to Hop.getHopId().
      Returns:
      current value

    • getLrsBits

      public Hop.LrsBits getLrsBits()
      Return current value associated with the property corresponding to Hop.getLrsBits().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Hop>> 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 HopBuilder withKey(HopKey key)
      Set the key value corresponding to Hop.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setAddress

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

    • setHopId

      public HopBuilder setHopId(String value)
      Set the property corresponding to Hop.getHopId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLrsBits

      public HopBuilder setLrsBits(Hop.LrsBits value)
      Set the property corresponding to Hop.getLrsBits() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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