Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.elan.rev150602.forwarding.entries

Class MacEntryBuilder

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

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

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

    • Constructor Detail

      • MacEntryBuilder

        public MacEntryBuilder()

      • MacEntryBuilder

        public MacEntryBuilder​(MacEntry base)

    • Method Detail

      • getControllerLearnedForwardingEntryTimestamp

        public org.opendaylight.yangtools.yang.common.Uint64 getControllerLearnedForwardingEntryTimestamp()

      • getInterface

        public java.lang.String getInterface()

      • getIpPrefix

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpPrefix()

      • getIsStaticAddress

        public java.lang.Boolean getIsStaticAddress()

      • isIsStaticAddress

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

      • getMacAddress

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

      • getSrcTorNodeid

        public java.lang.String getSrcTorNodeid()

      • augmentation

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

      • setControllerLearnedForwardingEntryTimestamp

        public MacEntryBuilder setControllerLearnedForwardingEntryTimestamp​(org.opendaylight.yangtools.yang.common.Uint64 value)

      • setControllerLearnedForwardingEntryTimestamp

        @Deprecated(forRemoval=true)
public MacEntryBuilder setControllerLearnedForwardingEntryTimestamp​(java.math.BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use setControllerLearnedForwardingEntryTimestamp(Uint64) instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setInterface

        public MacEntryBuilder setInterface​(java.lang.String value)

      • setIpPrefix

        public MacEntryBuilder setIpPrefix​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)

      • setIsStaticAddress

        public MacEntryBuilder setIsStaticAddress​(java.lang.Boolean value)

      • setMacAddress

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

      • setSrcTorNodeid

        public MacEntryBuilder setSrcTorNodeid​(java.lang.String value)

      • addAugmentation

        public MacEntryBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<MacEntry> 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 MacEntryBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MacEntry>> 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 MacEntry build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<MacEntry>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<MacEntry,​java.lang.IllegalArgumentException>