Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance

Class MappingBuilder

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

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

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

    • Constructor Detail

      • MappingBuilder

        public MappingBuilder()

      • MappingBuilder

        public MappingBuilder​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingRecordContainer arg)

      • MappingBuilder

        public MappingBuilder​(Mapping 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.lfm.lisp.proto.rev151105.MappingRecordContainer
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types

      • getEidUri

        public EidUri getEidUri()

      • getMappingRecord

        public org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord getMappingRecord()

      • getSiteId

        public List<org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.SiteId> getSiteId()

      • augmentation

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

      • setMappingRecord

        public MappingBuilder setMappingRecord​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord value)

      • setSiteId

        public MappingBuilder setSiteId​(List<org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.SiteId> values)

      • addAugmentation

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

      • removeAugmentation

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

      • build

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