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

Class EthernetTypeBuilder

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

   
     EthernetType createEthernetType(int fooXyzzy, int barBaz) {
         return new EthernetTypeBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • EthernetTypeBuilder

      public EthernetTypeBuilder()
      Construct an empty builder.

    • EthernetTypeBuilder

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

  • Method Details

    • getType

      public org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType getType()
      Return current value associated with the property corresponding to EthernetType.getType().
      Returns:
      current value

    • augmentation

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

    • setType

      public EthernetTypeBuilder setType(org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType value)
      Set the property corresponding to EthernetType.getType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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