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

Class MplsLabelBuilder

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

   
     MplsLabel createMplsLabel(int fooXyzzy, int barBaz) {
         return new MplsLabelBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MplsLabelBuilder

      public MplsLabelBuilder()
      Construct an empty builder.

    • MplsLabelBuilder

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

  • Method Details

    • getMplsLabel

      public org.opendaylight.yangtools.yang.common.Uint32 getMplsLabel()
      Return current value associated with the property corresponding to MplsLabel.getMplsLabel().
      Returns:
      current value

    • augmentation

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

    • setMplsLabel

      public MplsLabelBuilder setMplsLabel(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to MplsLabel.getMplsLabel() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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