Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730.aaa.top

Class AaaBuilder

  • @Generated("mdsal-binding-generator")
public class AaaBuilder
extends Object
    Class that builds Aaa 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: 

       
     Aaa createAaa(int fooXyzzy, int barBaz) {
         return new AaaBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • AaaBuilder

        public AaaBuilder()
        Construct an empty builder.

      • AaaBuilder

        public AaaBuilder​(AaaAuthenticationTop arg)
        Construct a new builder initialized from specified AaaAuthenticationTop.
        Parameters:
        arg - AaaAuthenticationTop from which the builder should be initialized

      • AaaBuilder

        public AaaBuilder​(AaaAuthorizationTop arg)
        Construct a new builder initialized from specified AaaAuthorizationTop.
        Parameters:
        arg - AaaAuthorizationTop from which the builder should be initialized

      • AaaBuilder

        public AaaBuilder​(AaaAccountingTop arg)
        Construct a new builder initialized from specified AaaAccountingTop.
        Parameters:
        arg - AaaAccountingTop from which the builder should be initialized

      • AaaBuilder

        public AaaBuilder​(Aaa base)
        Construct a builder initialized with state from specified Aaa.
        Parameters:
        base - Aaa from which the builder should be initialized

    • Method Detail

      • getConfig

        public Config getConfig()
        Return current value associated with the property corresponding to Aaa.getConfig().
        Returns:
        current value

      • getState

        public State getState()
        Return current value associated with the property corresponding to Aaa.getState().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Aaa>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        Parameters:
        augmentationType - augmentation type class
        Returns:
        Augmentation object from this builder, or null if not present
        Throws:
        NullPointerException - if augmentType is null

      • setConfig

        public AaaBuilder setConfig​(Config value)
        Set the property corresponding to Aaa.getConfig() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setState

        public AaaBuilder setState​(State value)
        Set the property corresponding to Aaa.getState() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

        public AaaBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Aaa> 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 AaaBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Aaa>> 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 @NonNull Aaa build()
        A new Aaa instance.
        Returns:
        A new Aaa instance.