Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib

Class RibBuilder

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

       
     Rib createRib(int fooXyzzy, int barBaz) {
         return new RibBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • RibBuilder

        public RibBuilder()
        Construct an empty builder.

      • RibBuilder

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

    • Method Detail

      • key

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

      • getId

        public RibId getId()
        Return current value associated with the property corresponding to Rib.getId().
        Returns:
        current value

      • getLocRib

        public LocRib getLocRib()
        Return current value associated with the property corresponding to Rib.getLocRib().
        Returns:
        current value

      • getPeer

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

      • augmentation

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

      • setId

        public RibBuilder setId​(RibId value)
        Set the property corresponding to Rib.getId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setLocRib

        public RibBuilder setLocRib​(LocRib value)
        Set the property corresponding to Rib.getLocRib() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPeer

        public RibBuilder setPeer​(Map<PeerKey,​Peer> values)
        Set the property corresponding to Rib.getPeer() to the specified value.
        Parameters:
        values - desired value
        Returns:
        this builder

      • addAugmentation

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