Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.flow.spec.object

Class FlowSpecObjectBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<FlowSpecObject>, org.opendaylight.yangtools.concepts.CheckedBuilder<FlowSpecObject,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class FlowSpecObjectBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowSpecObject>
    Class that builds FlowSpecObject 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: 

       
     FlowSpecObject createFlowSpecObject(int fooXyzzy, int barBaz) {
         return new FlowSpecObjectBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • FlowSpecObjectBuilder

        public FlowSpecObjectBuilder()

      • FlowSpecObjectBuilder

        public FlowSpecObjectBuilder​(RsvpTeObject arg)

      • FlowSpecObjectBuilder

        public FlowSpecObjectBuilder​(TspecObject arg)

      • FlowSpecObjectBuilder

        public FlowSpecObjectBuilder​(FlowSpecObject 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.rsvp.rev150820.TspecObject
        • RsvpTeObject
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getRate

        public Float32 getRate()

      • getSlackTerm

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

      • augmentation

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

      • setSlackTerm

        public FlowSpecObjectBuilder setSlackTerm​(org.opendaylight.yangtools.yang.common.Uint32 value)

      • addAugmentation

        public FlowSpecObjectBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        NullPointerException - if augmentation is null

      • removeAugmentation

        public FlowSpecObjectBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowSpecObject>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        Parameters:
        augmentationType - augmentation type to be removed
        Returns:
        this builder