Package org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112

Class ActionTypesBuilder

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

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

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

    • Constructor Detail

      • ActionTypesBuilder

        public ActionTypesBuilder()

      • ActionTypesBuilder

        public ActionTypesBuilder​(ActionList arg)

      • ActionTypesBuilder

        public ActionTypesBuilder​(ActionTypes 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.action.types.rev131112.ActionList
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • augmentation

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

      • addAugmentation

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

      • removeAugmentation

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