Package org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.ebgp.rev150901.bgp.neighborscontainer.neighbors

Class UpdateSourceBuilder

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

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

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

    • Constructor Detail

      • UpdateSourceBuilder

        public UpdateSourceBuilder()

      • UpdateSourceBuilder

        public UpdateSourceBuilder​(UpdateSource base)

    • Method Detail

      • getPeerIp

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

      • getSourceIp

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

      • augmentation

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

      • setPeerIp

        public UpdateSourceBuilder setPeerIp​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)

      • setSourceIp

        public UpdateSourceBuilder setSourceIp​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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