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

Class QosPolicyBuilder

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

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

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

    • Constructor Detail

      • QosPolicyBuilder

        public QosPolicyBuilder()

      • QosPolicyBuilder

        public QosPolicyBuilder​(IdAttributes arg)

      • QosPolicyBuilder

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

      • getName

        public String getName()

      • 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()

      • isShared

        public Boolean isShared()

      • augmentation

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

      • setTenantId

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

      • setUuid

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

      • addAugmentation

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

      • removeAugmentation

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