Class RouterBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Router>, org.opendaylight.yangtools.concepts.CheckedBuilder<Router,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    @Generated("mdsal-binding-generator")
    public class RouterBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<Router>
    Class that builds Router 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:

       
         Router createRouter(int fooXyzzy, int barBaz) {
             return new RouterBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • RouterBuilder

        public RouterBuilder()
      • RouterBuilder

        public RouterBuilder​(Peers arg)
      • RouterBuilder

        public RouterBuilder​(Router 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:
        • Peers
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getDescription

        public String getDescription()
      • getInfo

        public String getInfo()
      • getName

        public String getName()
      • getRouterId

        public RouterId getRouterId()
      • getStatus

        public Status getStatus()
      • augmentation

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

        public RouterBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Router> 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 RouterBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Router>> 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 Router build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Router>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Router,​IllegalArgumentException>