Class MetadataBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Metadata>, org.opendaylight.yangtools.concepts.CheckedBuilder<Metadata,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class MetadataBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<Metadata>
    Class that builds MetadataBuilder 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:

         MetadataBuilder createTarget(int fooXyzzy, int barBaz) {
             return new MetadataBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

    This pattern is supported by the immutable nature of MetadataBuilder, 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 oportunities, 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:
    MetadataBuilder, Builder
    • Constructor Detail

      • MetadataBuilder

        public MetadataBuilder()
      • MetadataBuilder

        public MetadataBuilder​(OfMetadata arg)
      • MetadataBuilder

        public MetadataBuilder​(Metadata base)
    • Method Detail

      • 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:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.OfMetadata
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getMetadata

        public org.opendaylight.yangtools.yang.common.Uint64 getMetadata()
      • getMetadataMask

        public org.opendaylight.yangtools.yang.common.Uint64 getMetadataMask()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>> E$$ augmentation​(Class<E$$> augmentationType)
      • setMetadata

        public MetadataBuilder setMetadata​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setMetadataMask

        public MetadataBuilder setMetadataMask​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • addAugmentation

        public MetadataBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Metadata> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        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.
        augmentationType - augmentation type to be removed
        this builder
      • build

        public Metadata build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Metadata>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Metadata,​IllegalArgumentException>