Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value

Class VlanVidCaseBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.VlanVidCaseBuilder
@Generated("mdsal-binding-generator") public class VlanVidCaseBuilder extends Object
Class that builds VlanVidCase 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: 

   
     VlanVidCase createVlanVidCase(int fooXyzzy, int barBaz) {
         return new VlanVidCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • VlanVidCaseBuilder

      public VlanVidCaseBuilder()
      Construct an empty builder.

    • VlanVidCaseBuilder

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

  • Method Details

    • getVlanVid

      public VlanVid getVlanVid()
      Return current value associated with the property corresponding to VlanVidCase.getVlanVid().
      Returns:
      current value

    • augmentation

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

    • setVlanVid

      public VlanVidCaseBuilder setVlanVid(VlanVid value)
      Set the property corresponding to VlanVidCase.getVlanVid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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