Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.proc.time.object

Class ProcTimeBuilder

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

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

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

    • Constructor Detail

      • ProcTimeBuilder

        public ProcTimeBuilder()

      • ProcTimeBuilder

        public ProcTimeBuilder​(Object arg)

      • ProcTimeBuilder

        public ProcTimeBuilder​(ObjectHeader arg)

      • ProcTimeBuilder

        public ProcTimeBuilder​(ProcTime 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.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getAverageProcTime

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

      • getCurrentProcTime

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

      • getMaxProcTime

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

      • getMinProcTime

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

      • getVarianceProcTime

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

      • isEstimated

        public Boolean isEstimated()

      • isIgnore

        public Boolean isIgnore()

      • isProcessingRule

        public Boolean isProcessingRule()

      • augmentation

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

      • setAverageProcTime

        public ProcTimeBuilder setAverageProcTime​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setAverageProcTime

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

      • setCurrentProcTime

        public ProcTimeBuilder setCurrentProcTime​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setCurrentProcTime

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

      • setMaxProcTime

        public ProcTimeBuilder setMaxProcTime​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMaxProcTime

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

      • setMinProcTime

        public ProcTimeBuilder setMinProcTime​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setMinProcTime

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

      • setVarianceProcTime

        public ProcTimeBuilder setVarianceProcTime​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setVarianceProcTime

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

        public ProcTime build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<ProcTime>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<ProcTime,​IllegalArgumentException>