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

Class TunnelIpv4MatchBuilder

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

   
     TunnelIpv4Match createTunnelIpv4Match(int fooXyzzy, int barBaz) {
         return new TunnelIpv4MatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TunnelIpv4MatchBuilder

      public TunnelIpv4MatchBuilder()
      Construct an empty builder.

    • TunnelIpv4MatchBuilder

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

    • TunnelIpv4MatchBuilder

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

    • getTunnelIpv4Destination

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

    • getTunnelIpv4Source

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

    • augmentation

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

    • setTunnelIpv4Destination

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

    • setTunnelIpv4Source

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

    • addAugmentation

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