Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.openflow.rev181121.openflow.agent.top

Class AgentBuilder

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

       
     Agent createAgent(int fooXyzzy, int barBaz) {
         return new AgentBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • AgentBuilder

        public AgentBuilder()

      • AgentBuilder

        public AgentBuilder​(Agent base)

    • Method Detail

      • getConfig

        public Config getConfig()

      • getState

        public State getState()

      • augmentation

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

      • addAugmentation

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

      • build

        public Agent build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Agent>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Agent,​IllegalArgumentException>