Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match

Class TcpMatchBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.TcpMatchBuilder
@Generated("mdsal-binding-generator") public class TcpMatchBuilder extends Object
Class that builds TcpMatch 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: 

   
     TcpMatch createTcpMatch(int fooXyzzy, int barBaz) {
         return new TcpMatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TcpMatchBuilder

      public TcpMatchBuilder()
      Construct an empty builder.

    • TcpMatchBuilder

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

    • TcpMatchBuilder

      public TcpMatchBuilder(TcpMatch base)
      Construct a builder initialized with state from specified TcpMatch.
      Parameters:
      base - TcpMatch 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

    • getTcpDestinationPort

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

    • getTcpDestinationPortMask

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

    • getTcpSourcePort

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

    • getTcpSourcePortMask

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

    • augmentation

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

    • setTcpDestinationPort

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

    • setTcpDestinationPortMask

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

    • setTcpSourcePort

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

    • setTcpSourcePortMask

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

    • addAugmentation

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