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

Class IpMatchBuilder

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

   
     IpMatch createIpMatch(int fooXyzzy, int barBaz) {
         return new IpMatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • IpMatchBuilder

      public IpMatchBuilder()
      Construct an empty builder.

    • IpMatchBuilder

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

    • IpMatchBuilder

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

    • getIpDscp

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

    • getIpEcn

      public org.opendaylight.yangtools.yang.common.Uint8 getIpEcn()
      Return current value associated with the property corresponding to IpMatchFields.getIpEcn().
      Returns:
      current value

    • getIpProto

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

    • getIpProtocol

      public org.opendaylight.yangtools.yang.common.Uint8 getIpProtocol()
      Return current value associated with the property corresponding to IpMatchFields.getIpProtocol().
      Returns:
      current value

    • augmentation

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

    • setIpDscp

      public IpMatchBuilder setIpDscp(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Dscp value)
      Set the property corresponding to IpMatchFields.getIpDscp() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpEcn

      public IpMatchBuilder setIpEcn(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to IpMatchFields.getIpEcn() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpProto

      public IpMatchBuilder setIpProto(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpVersion value)
      Set the property corresponding to IpMatchFields.getIpProto() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpProtocol

      public IpMatchBuilder setIpProtocol(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to IpMatchFields.getIpProtocol() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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