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

Class Ipv4MatchBuilder

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

   
     Ipv4Match createIpv4Match(int fooXyzzy, int barBaz) {
         return new Ipv4MatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Ipv4MatchBuilder

      public Ipv4MatchBuilder()
      Construct an empty builder.

    • Ipv4MatchBuilder

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

    • Ipv4MatchBuilder

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

    • getIpv4Destination

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

    • getIpv4Source

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

    • augmentation

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

    • setIpv4Destination

      public Ipv4MatchBuilder setIpv4Destination(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
      Set the property corresponding to Ipv4MatchFields.getIpv4Destination() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpv4Source

      public Ipv4MatchBuilder setIpv4Source(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
      Set the property corresponding to Ipv4MatchFields.getIpv4Source() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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