Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.bgp.confederation

Class PeersBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Peers>, org.opendaylight.yangtools.concepts.CheckedBuilder<Peers,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class PeersBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<Peers>
    Class that builds PeersBuilder 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: 

       
     PeersBuilder createTarget(int fooXyzzy, int barBaz) {
         return new PeersBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • PeersBuilder

        public PeersBuilder()

      • PeersBuilder

        public PeersBuilder​(Peers base)

    • Method Detail

      • getAsName

        public java.lang.String getAsName()

      • augmentation

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

      • setAsName

        public PeersBuilder setAsName​(java.lang.String value)

      • addAugmentation

        public PeersBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Peers>> augmentationType,
                                    org.opendaylight.yangtools.yang.binding.Augmentation<Peers> augmentationValue)

      • removeAugmentation

        public PeersBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Peers>> augmentationType)

      • build

        public Peers build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Peers>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Peers,​java.lang.IllegalArgumentException>