Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.neighbor.set.neighbor.set

Class NeighborBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.neighbor.set.neighbor.set.NeighborBuilder
@Generated("mdsal-binding-generator") public class NeighborBuilder extends Object
Class that builds Neighbor 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: 

   
     Neighbor createNeighbor(int fooXyzzy, int barBaz) {
         return new NeighborBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • NeighborBuilder

      public NeighborBuilder()
      Construct an empty builder.

    • NeighborBuilder

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

  • Method Details

    • key

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

    • getAddress

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

    • augmentation

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

    • setAddress

      public NeighborBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
      Set the property corresponding to Neighbor.getAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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