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

Class ArpMatchBuilder

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

   
     ArpMatch createArpMatch(int fooXyzzy, int barBaz) {
         return new ArpMatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ArpMatchBuilder

      public ArpMatchBuilder()
      Construct an empty builder.

    • ArpMatchBuilder

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

    • ArpMatchBuilder

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

    • getArpOp

      public org.opendaylight.yangtools.yang.common.Uint16 getArpOp()
      Return current value associated with the property corresponding to ArpMatchFields.getArpOp().
      Returns:
      current value

    • getArpSourceHardwareAddress

      public ArpSourceHardwareAddress getArpSourceHardwareAddress()
      Return current value associated with the property corresponding to ArpMatchFields.getArpSourceHardwareAddress().
      Returns:
      current value

    • getArpSourceTransportAddress

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

    • getArpTargetHardwareAddress

      public ArpTargetHardwareAddress getArpTargetHardwareAddress()
      Return current value associated with the property corresponding to ArpMatchFields.getArpTargetHardwareAddress().
      Returns:
      current value

    • getArpTargetTransportAddress

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

    • augmentation

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

    • setArpOp

      public ArpMatchBuilder setArpOp(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to ArpMatchFields.getArpOp() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setArpSourceHardwareAddress

      public ArpMatchBuilder setArpSourceHardwareAddress(ArpSourceHardwareAddress value)
      Set the property corresponding to ArpMatchFields.getArpSourceHardwareAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setArpSourceTransportAddress

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

    • setArpTargetHardwareAddress

      public ArpMatchBuilder setArpTargetHardwareAddress(ArpTargetHardwareAddress value)
      Set the property corresponding to ArpMatchFields.getArpTargetHardwareAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setArpTargetTransportAddress

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

    • addAugmentation

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