Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.qos.rev160613.qos.attributes.qos.policies.qos.policy

Class BandwidthLimitRulesBuilder

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

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

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

    • Constructor Detail

      • BandwidthLimitRulesBuilder

        public BandwidthLimitRulesBuilder()

      • BandwidthLimitRulesBuilder

        public BandwidthLimitRulesBuilder​(IdAttributes arg)

    • 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.neutron.qos.rev160613.BandwidthlimitRuleAttributes
        • org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.attrs.rev150712.IdAttributes
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getMaxBurstKbps

        public org.opendaylight.yangtools.yang.common.Uint64 getMaxBurstKbps()

      • getMaxKbps

        public org.opendaylight.yangtools.yang.common.Uint64 getMaxKbps()

      • getProjectId

        public String getProjectId()

      • getRevisionNumber

        public Long getRevisionNumber()

      • getTenantId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()

      • getUuid

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getUuid()

      • augmentation

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

      • setMaxBurstKbps

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

      • setMaxKbps

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

      • setTenantId

        public BandwidthLimitRulesBuilder setTenantId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)

      • setUuid

        public BandwidthLimitRulesBuilder setUuid​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)