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

Class UdpMatchBuilder

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

   
     UdpMatch createUdpMatch(int fooXyzzy, int barBaz) {
         return new UdpMatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • UdpMatchBuilder

      public UdpMatchBuilder()
      Construct an empty builder.

    • UdpMatchBuilder

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

    • UdpMatchBuilder

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

    • getUdpDestinationPort

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

    • getUdpDestinationPortMask

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

    • getUdpSourcePort

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

    • getUdpSourcePortMask

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

    • augmentation

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

    • setUdpDestinationPort

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

    • setUdpDestinationPortMask

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

    • setUdpSourcePort

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

    • setUdpSourcePortMask

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

    • addAugmentation

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