Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925

Class PortMessageBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.PortMessageBuilder
@Generated("mdsal-binding-generator") public class PortMessageBuilder extends Object
Class that builds PortMessage 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: 

   
     PortMessage createPortMessage(int fooXyzzy, int barBaz) {
         return new PortMessageBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PortMessageBuilder

      public PortMessageBuilder()
      Construct an empty builder.

    • PortMessageBuilder

      public PortMessageBuilder(CommonPortWithMask arg)
      Construct a new builder initialized from specified CommonPortWithMask.
      Parameters:
      arg - CommonPortWithMask from which the builder should be initialized

    • PortMessageBuilder

      public PortMessageBuilder(CommonPort arg)
      Construct a new builder initialized from specified CommonPort.
      Parameters:
      arg - CommonPort from which the builder should be initialized

    • PortMessageBuilder

      public PortMessageBuilder(OfHeader arg)
      Construct a new builder initialized from specified OfHeader.
      Parameters:
      arg - OfHeader from which the builder should be initialized

    • PortMessageBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • getAdvertisedFeatures

      public PortFeatures getAdvertisedFeatures()
      Return current value associated with the property corresponding to CommonPort.getAdvertisedFeatures().
      Returns:
      current value

    • getConfiguration

      public PortConfig getConfiguration()
      Return current value associated with the property corresponding to CommonPort.getConfiguration().
      Returns:
      current value

    • getHardwareAddress

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getHardwareAddress()
      Return current value associated with the property corresponding to CommonPort.getHardwareAddress().
      Returns:
      current value

    • getMask

      public PortConfig getMask()
      Return current value associated with the property corresponding to CommonPortWithMask.getMask().
      Returns:
      current value

    • getPortNumber

      public PortNumberUni getPortNumber()
      Return current value associated with the property corresponding to CommonPort.getPortNumber().
      Returns:
      current value

    • getVersion

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

    • getXid

      public org.opendaylight.yangtools.yang.common.Uint32 getXid()
      Return current value associated with the property corresponding to OfHeader.getXid().
      Returns:
      current value

    • augmentation

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

    • setAdvertisedFeatures

      public PortMessageBuilder setAdvertisedFeatures(PortFeatures value)
      Set the property corresponding to CommonPort.getAdvertisedFeatures() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConfiguration

      public PortMessageBuilder setConfiguration(PortConfig value)
      Set the property corresponding to CommonPort.getConfiguration() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setHardwareAddress

      public PortMessageBuilder setHardwareAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      Set the property corresponding to CommonPort.getHardwareAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMask

      public PortMessageBuilder setMask(PortConfig value)
      Set the property corresponding to CommonPortWithMask.getMask() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPortNumber

      public PortMessageBuilder setPortNumber(PortNumberUni value)
      Set the property corresponding to CommonPort.getPortNumber() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersion

      public PortMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to OfHeader.getVersion() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setXid

      public PortMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to OfHeader.getXid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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