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

Class EthernetMatchBuilder

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

   
     EthernetMatch createEthernetMatch(int fooXyzzy, int barBaz) {
         return new EthernetMatchBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • EthernetMatchBuilder

      public EthernetMatchBuilder()
      Construct an empty builder.

    • EthernetMatchBuilder

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

    • EthernetMatchBuilder

      public EthernetMatchBuilder(EthernetMatch base)
      Construct a builder initialized with state from specified EthernetMatch.
      Parameters:
      base - EthernetMatch from which the builder should be initialized

  • Method Details