Package org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.application.data

Class ApplicationDataBuilder

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

   
     ApplicationData createApplicationData(int fooXyzzy, int barBaz) {
         return new ApplicationDataBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ApplicationDataBuilder

      public ApplicationDataBuilder()
      Construct an empty builder.

    • ApplicationDataBuilder

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

  • Method Details

    • getAddress

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

    • getIpTos

      public Integer getIpTos()
      Return current value associated with the property corresponding to ApplicationData.getIpTos().
      Returns:
      current value

    • getLocalPortHigh

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

    • getLocalPortLow

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

    • getProtocol

      public org.opendaylight.yangtools.yang.common.Uint8 getProtocol()
      Return current value associated with the property corresponding to ApplicationData.getProtocol().
      Returns:
      current value

    • getRemotePortHigh

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

    • getRemotePortLow

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

    • augmentation

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

    • setAddress

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

    • setIpTos

      public ApplicationDataBuilder setIpTos(Integer value)
      Set the property corresponding to ApplicationData.getIpTos() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLocalPortHigh

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

    • setLocalPortLow

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

    • setProtocol

      public ApplicationDataBuilder setProtocol(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to ApplicationData.getProtocol() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setRemotePortHigh

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

    • setRemotePortLow

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

    • addAugmentation

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