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

Class PeerBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Peer>, org.opendaylight.yangtools.concepts.CheckedBuilder<Peer,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class PeerBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Peer>
    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, Builder

    • Constructor Detail

      • PeerBuilder

        public PeerBuilder()

      • PeerBuilder

        public PeerBuilder​(Peer arg)

      • PeerBuilder

        public PeerBuilder​(Peer 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:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.Peer
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getAddress

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getAddress()

      • getAs

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAs()

      • getBgpId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getBgpId()

      • getMirrors

        public Mirrors getMirrors()

      • getPeerId

        public PeerId getPeerId()

      • getRouterDistinguisher

        public String getRouterDistinguisher()

      • getStats

        public Stats getStats()

      • augmentation

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

      • setAddress

        public PeerBuilder setAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)

      • setAs

        public PeerBuilder setAs​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)

      • setBgpId

        public PeerBuilder setBgpId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)

      • setRouterDistinguisher

        public PeerBuilder setRouterDistinguisher​(String value)

      • 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 Peer build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Peer>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Peer,​IllegalArgumentException>