java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.instance.endpoint.local.remote.local.remote.RemoteBuilder

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

   
     Remote createRemote(int fooXyzzy, int barBaz) {
         return new RemoteBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • RemoteBuilder

      public RemoteBuilder()
      Construct an empty builder.
    • RemoteBuilder

      public RemoteBuilder(Remote base)
      Construct a builder initialized with state from specified Remote.
      Parameters:
      base - Remote from which the builder should be initialized
  • Method Details

    • getNeighbor

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

      public org.opendaylight.yangtools.yang.common.Uint32 getVirtualCircuitIdentifier()
      Return current value associated with the property corresponding to Remote.getVirtualCircuitIdentifier().
      Returns:
      current value
    • augmentation

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

      public RemoteBuilder setNeighbor(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
      Set the property corresponding to Remote.getNeighbor() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setVirtualCircuitIdentifier

      public RemoteBuilder setVirtualCircuitIdentifier(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Remote.getVirtualCircuitIdentifier() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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