Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.inter.vpn.link.state

Class FirstEndpointStateBuilder

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

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

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

    • Constructor Detail

      • FirstEndpointStateBuilder

        public FirstEndpointStateBuilder()

      • FirstEndpointStateBuilder

        public FirstEndpointStateBuilder​(FirstEndpointState base)

    • 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.netvirt.inter.vpn.link.rev160311.VpnEndpointStateAttribs
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getDpId

        public java.util.List<org.opendaylight.yangtools.yang.common.Uint64> getDpId()

      • getLportTag

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

      • getVpnUuid

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

      • augmentation

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

      • setDpId

        public FirstEndpointStateBuilder setDpId​(java.util.List<org.opendaylight.yangtools.yang.common.Uint64> values)

      • setLportTag

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

      • setVpnUuid

        public FirstEndpointStateBuilder setVpnUuid​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • build

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