Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.path.key.object.path.key

Class PathKeysBuilder

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

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

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

    • Constructor Detail

      • PathKeysBuilder

        public PathKeysBuilder()

      • PathKeysBuilder

        public PathKeysBuilder​(CSubobject arg)

      • PathKeysBuilder

        public PathKeysBuilder​(PathKeys 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.rsvp.rev150820.PathKeySubobject
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.CSubobject
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getPathKey

        public PathKey getPathKey()

      • getPceId

        public PceId getPceId()

      • isLoose

        public Boolean isLoose()

      • augmentation

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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