Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.l2.fib.attributes.l2.fib.table

Class L2FibEntryBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<L2FibEntry>, org.opendaylight.yangtools.concepts.CheckedBuilder<L2FibEntry,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class L2FibEntryBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<L2FibEntry>
    Class that builds L2FibEntryBuilder 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: 

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

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

    • Constructor Detail

      • L2FibEntryBuilder

        public L2FibEntryBuilder()

      • L2FibEntryBuilder

        public L2FibEntryBuilder​(L2FibEntry base)

    • Method Detail

      • getAction

        public java.lang.Class<? extends L2FibAction> getAction()

      • getBridgedVirtualInterface

        public java.lang.Boolean getBridgedVirtualInterface()

      • isBridgedVirtualInterface

        @Deprecated(forRemoval=true)
public final java.lang.Boolean isBridgedVirtualInterface()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getOutgoingInterface

        public java.lang.String getOutgoingInterface()

      • getPhysAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress getPhysAddress()

      • getStaticConfig

        public java.lang.Boolean getStaticConfig()

      • isStaticConfig

        @Deprecated(forRemoval=true)
public final java.lang.Boolean isStaticConfig()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • augmentation

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

      • setBridgedVirtualInterface

        public L2FibEntryBuilder setBridgedVirtualInterface​(java.lang.Boolean value)

      • setOutgoingInterface

        public L2FibEntryBuilder setOutgoingInterface​(java.lang.String value)

      • setPhysAddress

        public L2FibEntryBuilder setPhysAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress value)

      • setStaticConfig

        public L2FibEntryBuilder setStaticConfig​(java.lang.Boolean value)

      • addAugmentation

        public L2FibEntryBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<L2FibEntry> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        java.lang.NullPointerException - if augmentation is null

      • removeAugmentation

        public L2FibEntryBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L2FibEntry>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        Parameters:
        augmentationType - augmentation type to be removed
        Returns:
        this builder

      • build

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