Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address

Class TransportAddressBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.transport.address.TransportAddressBuilder
@Generated("mdsal-binding-generator") public class TransportAddressBuilder extends Object
Class that builds TransportAddress 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: 

   
     TransportAddress createTransportAddress(int fooXyzzy, int barBaz) {
         return new TransportAddressBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TransportAddressBuilder

      public TransportAddressBuilder()
      Construct an empty builder.

    • TransportAddressBuilder

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

  • Method Details

    • getIpAddress

      public IpAddressBinary getIpAddress()
      Return current value associated with the property corresponding to TransportAddress.getIpAddress().
      Returns:
      current value

    • getPort

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

    • augmentation

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

    • setIpAddress

      public TransportAddressBuilder setIpAddress(IpAddressBinary value)
      Set the property corresponding to TransportAddress.getIpAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPort

      public TransportAddressBuilder setPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
      Set the property corresponding to TransportAddress.getPort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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