Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.routers

Class RouterBuilder

  • @Generated("mdsal-binding-generator")
public class RouterBuilder
extends Object
    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

    • Constructor Detail

      • RouterBuilder

        public RouterBuilder()
        Construct an empty builder.

      • RouterBuilder

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

      • RouterBuilder

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

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

      • key

        public RouterKey key()
        Return current value associated with the property corresponding to Router.key().
        Returns:
        current value

      • getDescription

        public String getDescription()
        Return current value associated with the property corresponding to Router.getDescription().
        Returns:
        current value

      • getInfo

        public String getInfo()
        Return current value associated with the property corresponding to Router.getInfo().
        Returns:
        current value

      • getName

        public String getName()
        Return current value associated with the property corresponding to Router.getName().
        Returns:
        current value

      • getPeer

        public Map<PeerKey,​Peer> getPeer()
        Return current value associated with the property corresponding to Peers.getPeer().
        Returns:
        current value

      • getRouterId

        public RouterId getRouterId()
        Return current value associated with the property corresponding to Router.getRouterId().
        Returns:
        current value

      • getStatus

        public Status getStatus()
        Return current value associated with the property corresponding to Router.getStatus().
        Returns:
        current value

      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Router>> 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

      • setDescription

        public RouterBuilder setDescription​(String value)
        Set the property corresponding to Router.getDescription() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setInfo

        public RouterBuilder setInfo​(String value)
        Set the property corresponding to Router.getInfo() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setName

        public RouterBuilder setName​(String value)
        Set the property corresponding to Router.getName() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setStatus

        public RouterBuilder setStatus​(Status value)
        Set the property corresponding to Router.getStatus() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • 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 @NonNull Router build()
        A new Router instance.
        Returns:
        A new Router instance.