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

Class PeerBuilder

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

       
     Peer createPeer(int fooXyzzy, int barBaz) {
         return new PeerBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • PeerBuilder

        public PeerBuilder()
        Construct an empty builder.

      • PeerBuilder

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

    • Method Detail

      • key

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

      • getAdjRibIn

        public AdjRibIn getAdjRibIn()
        Return current value associated with the property corresponding to Peer.getAdjRibIn().
        Returns:
        current value

      • getAdjRibOut

        public AdjRibOut getAdjRibOut()
        Return current value associated with the property corresponding to Peer.getAdjRibOut().
        Returns:
        current value

      • getPeerId

        public PeerId getPeerId()
        Return current value associated with the property corresponding to Peer.getPeerId().
        Returns:
        current value

      • getPeerRole

        public PeerRole getPeerRole()
        Return current value associated with the property corresponding to Peer.getPeerRole().
        Returns:
        current value

      • augmentation

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

      • setAdjRibIn

        public PeerBuilder setAdjRibIn​(AdjRibIn value)
        Set the property corresponding to Peer.getAdjRibIn() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setAdjRibOut

        public PeerBuilder setAdjRibOut​(AdjRibOut value)
        Set the property corresponding to Peer.getAdjRibOut() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPeerId

        public PeerBuilder setPeerId​(PeerId value)
        Set the property corresponding to Peer.getPeerId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setPeerRole

        public PeerBuilder setPeerRole​(PeerRole value)
        Set the property corresponding to Peer.getPeerRole() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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