java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._4.match.SctpMatchBuilder

@Generated("mdsal-binding-generator") public class SctpMatchBuilder extends Object
Class that builds SctpMatch 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:

   
     SctpMatch createSctpMatch(int fooXyzzy, int barBaz) {
         return new SctpMatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • SctpMatchBuilder

      public SctpMatchBuilder()
      Construct an empty builder.
    • SctpMatchBuilder

      public SctpMatchBuilder(SctpMatchFields arg)
      Construct a new builder initialized from specified SctpMatchFields.
      Parameters:
      arg - SctpMatchFields from which the builder should be initialized
    • SctpMatchBuilder

      public SctpMatchBuilder(SctpMatch base)
      Construct a builder initialized with state from specified SctpMatch.
      Parameters:
      base - SctpMatch 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
    • getSctpDestinationPort

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

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

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

      public SctpMatchBuilder setSctpDestinationPort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
      Set the property corresponding to SctpMatchFields.getSctpDestinationPort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setSctpSourcePort

      public SctpMatchBuilder setSctpSourcePort(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber value)
      Set the property corresponding to SctpMatchFields.getSctpSourcePort() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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