Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables

Class TableBuilder

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

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

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

    • Constructor Detail

      • TableBuilder

        public TableBuilder()

      • TableBuilder

        public TableBuilder​(Table base)

    • Method Detail

      • getId

        public org.opendaylight.yangtools.yang.common.Uint8 getId()

      • augmentation

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

      • setId

        public TableBuilder setId​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setId

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

      • addAugmentation

        public TableBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Table>> augmentationType,
                                    org.opendaylight.yangtools.yang.binding.Augmentation<Table> augmentationValue)

      • removeAugmentation

        public TableBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Table>> augmentationType)

      • build

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