Package org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match

Class MetadataBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.MetadataBuilder
@Generated("mdsal-binding-generator") public class MetadataBuilder extends Object
Class that builds Metadata 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: 

   
     Metadata createMetadata(int fooXyzzy, int barBaz) {
         return new MetadataBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • MetadataBuilder

      public MetadataBuilder()
      Construct an empty builder.

    • MetadataBuilder

      public MetadataBuilder(OfMetadata arg)
      Construct a new builder initialized from specified OfMetadata.
      Parameters:
      arg - OfMetadata from which the builder should be initialized

    • MetadataBuilder

      public MetadataBuilder(Metadata base)
      Construct a builder initialized with state from specified Metadata.
      Parameters:
      base - Metadata 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

    • getMetadata

      public org.opendaylight.yangtools.yang.common.Uint64 getMetadata()
      Return current value associated with the property corresponding to OfMetadata.getMetadata().
      Returns:
      current value

    • getMetadataMask

      public org.opendaylight.yangtools.yang.common.Uint64 getMetadataMask()
      Return current value associated with the property corresponding to OfMetadata.getMetadataMask().
      Returns:
      current value

    • augmentation

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

    • setMetadata

      public MetadataBuilder setMetadata(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to OfMetadata.getMetadata() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMetadataMask

      public MetadataBuilder setMetadataMask(org.opendaylight.yangtools.yang.common.Uint64 value)
      Set the property corresponding to OfMetadata.getMetadataMask() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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