Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rpcs.rev160406

Class GetPortFromInterfaceOutputBuilder

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

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

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

    • Constructor Detail

      • GetPortFromInterfaceOutputBuilder

        public GetPortFromInterfaceOutputBuilder()

    • Method Detail

      • getDpid

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

      • getPhyAddress

        public java.lang.String getPhyAddress()

      • getPortname

        public java.lang.String getPortname()

      • getPortno

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

      • augmentation

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

      • setDpid

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

      • setPortno

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