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

Class GetMappingInputBuilder

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

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

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

    • Constructor Detail

      • GetMappingInputBuilder

        public GetMappingInputBuilder()

      • GetMappingInputBuilder

        public GetMappingInputBuilder​(EidContainer arg)

      • GetMappingInputBuilder

        public GetMappingInputBuilder​(GetMappingInput 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.EidContainer
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getEid

        public Eid getEid()

      • augmentation

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

      • addAugmentation

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

      • removeAugmentation

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

      • build

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