Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.label.subobject.label.type.type1.label._case

Class Type1LabelBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.label.subobject.label.type.type1.label._case.Type1LabelBuilder
@Generated("mdsal-binding-generator") public class Type1LabelBuilder extends Object
Class that builds Type1Label 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: 

   
     Type1Label createType1Label(int fooXyzzy, int barBaz) {
         return new Type1LabelBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Type1LabelBuilder

      public Type1LabelBuilder()
      Construct an empty builder.

    • Type1LabelBuilder

      public Type1LabelBuilder(Type1Label arg)
      Construct a new builder initialized from specified Type1Label.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.Type1Label from which the builder should be initialized

    • Type1LabelBuilder

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

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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 Type1Label empty()
      Get empty instance of Type1Label.
      Returns:
      An empty Type1Label

    • getType1Label

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

    • augmentation

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

    • setType1Label

      public Type1LabelBuilder setType1Label(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to Type1Label.getType1Label() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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