java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820._record.route.subobjects.subobject.type.label._case.LabelBuilder

@Generated("mdsal-binding-generator") public class LabelBuilder extends Object
Class that builds Label 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:

   
     Label createLabel(int fooXyzzy, int barBaz) {
         return new LabelBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • LabelBuilder

      public LabelBuilder()
      Construct an empty builder.
    • LabelBuilder

      public LabelBuilder(LabelSubobject arg)
      Construct a new builder initialized from specified LabelSubobject.
      Parameters:
      arg - LabelSubobject from which the builder should be initialized
    • LabelBuilder

      public LabelBuilder(CSubobject arg)
      Construct a new builder initialized from specified CSubobject.
      Parameters:
      arg - CSubobject from which the builder should be initialized
    • LabelBuilder

      public LabelBuilder(Label base)
      Construct a builder initialized with state from specified Label.
      Parameters:
      base - Label from which the builder should be initialized
  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
    • empty

      public static @NonNull Label empty()
      Get empty instance of Label.
      Returns:
      An empty Label
    • getGlobal

      public Boolean getGlobal()
      Return current value associated with the property corresponding to Label.getGlobal().
      Returns:
      current value
    • getLabelType

      public LabelType getLabelType()
      Return current value associated with the property corresponding to LabelSubobject.getLabelType().
      Returns:
      current value
    • getUniDirectional

      public Boolean getUniDirectional()
      Return current value associated with the property corresponding to LabelSubobject.getUniDirectional().
      Returns:
      current value
    • augmentation

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

      public LabelBuilder setGlobal(Boolean value)
      Set the property corresponding to Label.getGlobal() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setLabelType

      public LabelBuilder setLabelType(LabelType value)
      Set the property corresponding to LabelSubobject.getLabelType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setUniDirectional

      public LabelBuilder setUniDirectional(Boolean value)
      Set the property corresponding to LabelSubobject.getUniDirectional() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

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