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

     MetadataValues createMetadataValues(int fooXyzzy, int barBaz) {
         return new MetadataValuesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())

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

    • MetadataValuesBuilder

      public MetadataValuesBuilder()
      Construct an empty builder.
    • MetadataValuesBuilder

      public MetadataValuesBuilder(MetadataValues base)
      Construct a builder initialized with state from specified MetadataValues.
      base - MetadataValues from which the builder should be initialized
  • Method Details

    • getMetadata

      public org.opendaylight.yangtools.yang.common.Uint32 getMetadata()
      Return current value associated with the property corresponding to MetadataValues.getMetadata().
      current value
    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MetadataValues>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      augmentationType - augmentation type class
      Augmentation object from this builder, or null if not present
      NullPointerException - if augmentType is null
    • setMetadata

      public MetadataValuesBuilder setMetadata(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to MetadataValues.getMetadata() to the specified value.
      value - desired value
      this builder
    • addAugmentation

      public MetadataValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MetadataValues> augmentation)
      Add an augmentation to this builder's product.
      augmentation - augmentation to be added
      this builder
      NullPointerException - if augmentation is null
    • removeAugmentation

      public MetadataValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MetadataValues>> augmentationType)
      Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
      augmentationType - augmentation type to be removed
      this builder
    • build

      public @NonNull MetadataValues build()
      A new MetadataValues instance.
      A new MetadataValues instance.