Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.queue

Class PropertiesBuilder

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

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

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

    • Constructor Detail

      • PropertiesBuilder

        public PropertiesBuilder()

      • PropertiesBuilder

        public PropertiesBuilder​(Properties base)

    • Method Detail

      • getMaximumRate

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

      • getMinimumRate

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

      • augmentation

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

      • setMaximumRate

        public PropertiesBuilder setMaximumRate​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMaximumRate

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

      • setMinimumRate

        public PropertiesBuilder setMinimumRate​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMinimumRate

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

      • addAugmentation

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

      • removeAugmentation

        public PropertiesBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Properties>> augmentationType)