Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type

Class ExperimenterBuilder

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

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

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

    • Constructor Detail

      • ExperimenterBuilder

        public ExperimenterBuilder()

      • ExperimenterBuilder

        public ExperimenterBuilder​(Experimenter base)

    • Method Detail

      • getExperimenter

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

      • getExperimenterBurstSize

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

      • getExperimenterRate

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

      • getExperimenterType

        public MeterBandType getExperimenterType()

      • augmentation

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

      • setExperimenter

        public ExperimenterBuilder setExperimenter​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setExperimenter

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

      • setExperimenterBurstSize

        public ExperimenterBuilder setExperimenterBurstSize​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setExperimenterBurstSize

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

      • setExperimenterRate

        public ExperimenterBuilder setExperimenterRate​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setExperimenterRate

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

      • addAugmentation

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