Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.path.binding.tlv.path.binding.binding.type.value

Class MplsLabelEntryBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.path.binding.tlv.path.binding.binding.type.value.MplsLabelEntryBuilder
@Generated("mdsal-binding-generator") public class MplsLabelEntryBuilder extends Object
Class that builds MplsLabelEntry 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: 

   
     MplsLabelEntry createMplsLabelEntry(int fooXyzzy, int barBaz) {
         return new MplsLabelEntryBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MplsLabelEntryBuilder

      public MplsLabelEntryBuilder()
      Construct an empty builder.

    • MplsLabelEntryBuilder

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

  • Method Details

    • getBottomOfStack

      public Boolean getBottomOfStack()
      Return current value associated with the property corresponding to MplsLabelEntry.getBottomOfStack().
      Returns:
      current value

    • getLabel

      public MplsLabel getLabel()
      Return current value associated with the property corresponding to MplsLabelEntry.getLabel().
      Returns:
      current value

    • getTimeToLive

      public org.opendaylight.yangtools.yang.common.Uint8 getTimeToLive()
      Return current value associated with the property corresponding to MplsLabelEntry.getTimeToLive().
      Returns:
      current value

    • getTrafficClass

      public org.opendaylight.yangtools.yang.common.Uint8 getTrafficClass()
      Return current value associated with the property corresponding to MplsLabelEntry.getTrafficClass().
      Returns:
      current value

    • augmentation

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

    • setBottomOfStack

      public MplsLabelEntryBuilder setBottomOfStack(Boolean value)
      Set the property corresponding to MplsLabelEntry.getBottomOfStack() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setLabel

      public MplsLabelEntryBuilder setLabel(MplsLabel value)
      Set the property corresponding to MplsLabelEntry.getLabel() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTimeToLive

      public MplsLabelEntryBuilder setTimeToLive(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to MplsLabelEntry.getTimeToLive() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTrafficClass

      public MplsLabelEntryBuilder setTrafficClass(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to MplsLabelEntry.getTrafficClass() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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