Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface

Class TapBuilder

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

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

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

    • 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.params.xml.ns.yang.v3po.rev170607.TapInterfaceBaseAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.InterfaceTag
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.TapInterfaceConfigAttributes
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getDeviceInstance

        public org.opendaylight.yangtools.yang.common.Uint32 getDeviceInstance()

      • getMac

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

      • getTag

        public java.lang.String getTag()

      • getTapName

        public java.lang.String getTapName()

      • augmentation

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

      • setDeviceInstance

        public TapBuilder setDeviceInstance​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setDeviceInstance

        @Deprecated(forRemoval=true)
public TapBuilder setDeviceInstance​(java.lang.Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setDeviceInstance(Uint32)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder

      • setMac

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

      • setTag

        public TapBuilder setTag​(java.lang.String value)

      • setTapName

        public TapBuilder setTapName​(java.lang.String value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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