Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries

Class Ipv4TableBuilder

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

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

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

    • Constructor Detail

      • Ipv4TableBuilder

        public Ipv4TableBuilder()

      • Ipv4TableBuilder

        public Ipv4TableBuilder​(Ipv4Entries arg)

      • Ipv4TableBuilder

        public Ipv4TableBuilder​(Ipv4Table 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.netvirt.fibmanager.rev150330.Ipv4Entries
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getIpv4Entry

        public java.util.List<Ipv4Entry> getIpv4Entry()

      • augmentation

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

      • addAugmentation

        public Ipv4TableBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Table>> augmentationType,
                                        org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Table> augmentationValue)

      • removeAugmentation

        public Ipv4TableBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Table>> augmentationType)

      • build

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