Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.meta.rev171210.dpn.to._interface.list.dpn.to._interface

Class InterfaceNameEntryBuilder

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

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

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

    • Constructor Detail

      • InterfaceNameEntryBuilder

        public InterfaceNameEntryBuilder()

      • InterfaceNameEntryBuilder

        public InterfaceNameEntryBuilder​(InterfaceNameEntry base)

    • Method Detail

      • getInterfaceName

        public java.lang.String getInterfaceName()

      • getInterfaceType

        public java.lang.Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> getInterfaceType()

      • augmentation

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

      • setInterfaceType

        public InterfaceNameEntryBuilder setInterfaceType​(java.lang.Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> value)

      • build

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