Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Class GetAsyncInputBuilder

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

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

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

    • Constructor Detail

      • GetAsyncInputBuilder

        public GetAsyncInputBuilder()

      • GetAsyncInputBuilder

        public GetAsyncInputBuilder​(GetAsyncRequest arg)

      • GetAsyncInputBuilder

        public GetAsyncInputBuilder​(OfHeader arg)

      • GetAsyncInputBuilder

        public GetAsyncInputBuilder​(GetAsyncInput 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.openflow.protocol.rev130731.OfHeader
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetAsyncRequest
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getVersion

        public org.opendaylight.yangtools.yang.common.Uint8 getVersion()

      • getXid

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

      • augmentation

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

      • setVersion

        public GetAsyncInputBuilder setVersion​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setVersion

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

      • setXid

        public GetAsyncInputBuilder setXid​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setXid

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

      • addAugmentation

        public GetAsyncInputBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetAsyncInput>> augmentationType,
                                            org.opendaylight.yangtools.yang.binding.Augmentation<GetAsyncInput> augmentationValue)