Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.supported.actions

Class ActionTypeBuilder

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

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

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

    • Constructor Detail

      • ActionTypeBuilder

        public ActionTypeBuilder()

      • ActionTypeBuilder

        public ActionTypeBuilder​(Feature arg)

      • ActionTypeBuilder

        public ActionTypeBuilder​(ActionType 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.flow.inventory.rev130819.Feature
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getAction

        public String getAction()

      • getSupportState

        public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.SupportType getSupportState()

      • augmentation

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

      • setSupportState

        public ActionTypeBuilder setSupportState​(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.SupportType value)

      • addAugmentation

        public ActionTypeBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<ActionType> 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 ActionTypeBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionType>> 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