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

Class ExperimenterMessageBuilder

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

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

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

    • Constructor Detail

      • ExperimenterMessageBuilder

        public ExperimenterMessageBuilder()

      • ExperimenterMessageBuilder

        public ExperimenterMessageBuilder​(OfHeader arg)

      • ExperimenterMessageBuilder

        public ExperimenterMessageBuilder​(ExperimenterCore arg)

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

      • getExpType

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

      • 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<ExperimenterMessage>> E$$ augmentation​(Class<E$$> augmentationType)

      • setExpType

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

      • setVersion

        @Deprecated(forRemoval=true)
public ExperimenterMessageBuilder 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

        @Deprecated(forRemoval=true)
public ExperimenterMessageBuilder 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