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

Class DscpRemarkBuilder

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

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

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

    • Constructor Detail

      • DscpRemarkBuilder

        public DscpRemarkBuilder()

      • DscpRemarkBuilder

        public DscpRemarkBuilder​(DscpRemark base)

    • Method Detail

      • getDscpRemarkBurstSize

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

      • getDscpRemarkRate

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

      • getPrecLevel

        public org.opendaylight.yangtools.yang.common.Uint8 getPrecLevel()

      • augmentation

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

      • setDscpRemarkBurstSize

        public DscpRemarkBuilder setDscpRemarkBurstSize​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setDscpRemarkBurstSize

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

      • setDscpRemarkRate

        public DscpRemarkBuilder setDscpRemarkRate​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • setDscpRemarkRate

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

      • setPrecLevel

        public DscpRemarkBuilder setPrecLevel​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • setPrecLevel

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

      • addAugmentation

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

      • removeAugmentation

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