Class FibEntriesBuilder

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

    public class FibEntriesBuilder
    extends java.lang.Object
    implements org.opendaylight.yangtools.concepts.Builder<FibEntries>
    Class that builds FibEntriesBuilder 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:

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

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

      • FibEntriesBuilder

        public FibEntriesBuilder()
      • FibEntriesBuilder

        public FibEntriesBuilder​(FibEntries base)
    • Method Detail

      • getIpv4Table

        public Ipv4Table getIpv4Table()
      • getVrfTables

        public java.util.List<VrfTables> getVrfTables()
      • augmentation

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

        public FibEntriesBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FibEntries>> augmentationType,
                                                 org.opendaylight.yangtools.yang.binding.Augmentation<FibEntries> augmentationValue)
      • removeAugmentation

        public FibEntriesBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FibEntries>> augmentationType)
      • build

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