Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.tunnel.rev130819.network.topology.topology

Class PathsBuilder

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

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

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

    • Constructor Detail

      • PathsBuilder

        public PathsBuilder()

      • PathsBuilder

        public PathsBuilder​(Paths base)

    • Method Detail

      • getPathId

        public PathId getPathId()

      • getPathTypes

        public PathTypes getPathTypes()

      • augmentation

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

      • addAugmentation

        public PathsBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Paths>> augmentationType,
                                    org.opendaylight.yangtools.yang.binding.Augmentation<Paths> augmentationValue)

      • removeAugmentation

        public PathsBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Paths>> augmentationType)

      • build

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