Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.supported.match.types

Class MatchTypeBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.supported.match.types.MatchTypeBuilder
@Generated("mdsal-binding-generator") public class MatchTypeBuilder extends Object
Class that builds MatchType 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: 

   
     MatchType createMatchType(int fooXyzzy, int barBaz) {
         return new MatchTypeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MatchTypeBuilder

      public MatchTypeBuilder()
      Construct an empty builder.

    • MatchTypeBuilder

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

    • MatchTypeBuilder

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

    • key

      public MatchTypeKey key()
      Return current value associated with the property corresponding to MatchType.key().
      Returns:
      current value

    • getMatch

      public String getMatch()
      Return current value associated with the property corresponding to MatchType.getMatch().
      Returns:
      current value

    • getSupportState

      public SupportType getSupportState()
      Return current value associated with the property corresponding to Feature.getSupportState().
      Returns:
      current value

    • augmentation

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

    • withKey

      public MatchTypeBuilder withKey(MatchTypeKey key)
      Set the key value corresponding to MatchType.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setMatch

      public MatchTypeBuilder setMatch(String value)
      Set the property corresponding to MatchType.getMatch() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSupportState

      public MatchTypeBuilder setSupportState(SupportType value)
      Set the property corresponding to Feature.getSupportState() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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