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

Class HelloInputBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<HelloInput>, org.opendaylight.yangtools.concepts.CheckedBuilder<HelloInput,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class HelloInputBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<HelloInput>
    Class that builds HelloInputBuilder 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: 

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

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

    • Constructor Detail

      • HelloInputBuilder

        public HelloInputBuilder()

      • HelloInputBuilder

        public HelloInputBuilder​(Hello arg)

      • HelloInputBuilder

        public HelloInputBuilder​(OfHeader arg)

      • HelloInputBuilder

        public HelloInputBuilder​(HelloInput 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.Hello
        • org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

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

      • setVersion

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

      • setVersion

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

      • setXid

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

      • setXid

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

      • addAugmentation

        public HelloInputBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<HelloInput> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        NullPointerException - if augmentation is null

      • removeAugmentation

        public HelloInputBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<HelloInput>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        Parameters:
        augmentationType - augmentation type to be removed
        Returns:
        this builder