Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.prefix.lists

Class PrefixListBuilder

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

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

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

    • Constructor Detail

      • PrefixListBuilder

        public PrefixListBuilder()

      • PrefixListBuilder

        public PrefixListBuilder​(PrefixList base)

    • Method Detail

      • getPrefixListName

        public java.lang.String getPrefixListName()

      • getPrefixes

        public Prefixes getPrefixes()

      • augmentation

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

      • setPrefixListName

        public PrefixListBuilder setPrefixListName​(java.lang.String value)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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