Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container

Class MappingRecordBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<MappingRecord>, org.opendaylight.yangtools.concepts.CheckedBuilder<MappingRecord,​java.lang.IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class MappingRecordBuilder
extends java.lang.Object
implements org.opendaylight.yangtools.concepts.Builder<MappingRecord>
    Class that builds MappingRecordBuilder 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: 

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

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

    • Constructor Detail

      • MappingRecordBuilder

        public MappingRecordBuilder()

      • MappingRecordBuilder

        public MappingRecordBuilder​(EidContainer arg)

      • MappingRecordBuilder

        public MappingRecordBuilder​(LocatorRecords arg)

      • MappingRecordBuilder

        public MappingRecordBuilder​(MappingRecord 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
        • org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.LocatorRecords
        • org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingRecordMetadata
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getAuthoritative

        public java.lang.Boolean getAuthoritative()

      • isAuthoritative

        @Deprecated(forRemoval=true)
public final java.lang.Boolean isAuthoritative()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getEid

        public Eid getEid()

      • getLocatorRecord

        public java.util.List<LocatorRecord> getLocatorRecord()

      • getMapVersion

        public java.lang.Short getMapVersion()

      • getRecordTtl

        public java.lang.Integer getRecordTtl()

      • getSiteId

        public SiteId getSiteId()

      • getTimestamp

        public java.lang.Long getTimestamp()

      • getXtrId

        public XtrId getXtrId()

      • augmentation

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

      • addAugmentation

        public MappingRecordBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecord> augmentation)
        Add an augmentation to this builder's product.
        Parameters:
        augmentation - augmentation to be added
        Returns:
        this builder
        Throws:
        java.lang.NullPointerException - if augmentation is null

      • removeAugmentation

        public MappingRecordBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MappingRecord>> augmentationType)
        Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
        Parameters:
        augmentationType - augmentation type to be removed
        Returns:
        this builder

      • build

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