Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.util.rev170210

Class PacketMetadataBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<PacketMetadata>, org.opendaylight.yangtools.concepts.CheckedBuilder<PacketMetadata,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class PacketMetadataBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<PacketMetadata>
    Class that builds PacketMetadataBuilder 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: 

       
     PacketMetadataBuilder createTarget(int fooXyzzy, int barBaz) {
         return new PacketMetadataBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • PacketMetadataBuilder

        public PacketMetadataBuilder()

      • PacketMetadataBuilder

        public PacketMetadataBuilder​(PacketMetadata 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.genius.ipv6.nd.util.rev170210.PacketMetadataInfo
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getInterface

        public java.lang.String getInterface()

      • getMetadata

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

      • getOfTableId

        public org.opendaylight.yangtools.yang.common.Uint32 getOfTableId()

      • setMetadata

        public PacketMetadataBuilder setMetadata​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setMetadata

        @Deprecated(forRemoval=true)
public PacketMetadataBuilder setMetadata​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setMetadata(Uint64)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setOfTableId

        public PacketMetadataBuilder setOfTableId​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setOfTableId

        @Deprecated(forRemoval=true)
public PacketMetadataBuilder setOfTableId​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setOfTableId(Uint32)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • build

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