Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapregistermessage

Class MapRegisterBuilder

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

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

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

    • Constructor Detail

      • MapRegisterBuilder

        public MapRegisterBuilder()

      • MapRegisterBuilder

        public MapRegisterBuilder​(MapRegister arg)

      • MapRegisterBuilder

        public MapRegisterBuilder​(XtrSiteId arg)

      • MapRegisterBuilder

        public MapRegisterBuilder​(MapRegister 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.MapRegister
        • org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MappingRecordList
        • org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.XtrSiteId
        Parameters:
        arg - grouping object
        Throws:
        java.lang.IllegalArgumentException - if given argument is none of valid types

      • getAuthenticationData

        public byte[] getAuthenticationData()

      • getKeyId

        public java.lang.Short getKeyId()

      • getMappingRecordItem

        public java.util.List<MappingRecordItem> getMappingRecordItem()

      • getNonce

        public java.lang.Long getNonce()

      • getSiteId

        public SiteId getSiteId()

      • getXtrId

        public XtrId getXtrId()

      • isMergeEnabled

        public java.lang.Boolean isMergeEnabled()

      • isProxyMapReply

        public java.lang.Boolean isProxyMapReply()

      • isWantMapNotify

        public java.lang.Boolean isWantMapNotify()

      • isXtrSiteIdPresent

        public java.lang.Boolean isXtrSiteIdPresent()

      • augmentation

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

      • setAuthenticationData

        public MapRegisterBuilder setAuthenticationData​(byte[] value)

      • setMergeEnabled

        public MapRegisterBuilder setMergeEnabled​(java.lang.Boolean value)

      • setProxyMapReply

        public MapRegisterBuilder setProxyMapReply​(java.lang.Boolean value)

      • setWantMapNotify

        public MapRegisterBuilder setWantMapNotify​(java.lang.Boolean value)

      • setXtrSiteIdPresent

        public MapRegisterBuilder setXtrSiteIdPresent​(java.lang.Boolean value)

      • addAugmentation

        public MapRegisterBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<MapRegister> 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

      • addAugmentation

        @Deprecated(forRemoval=true)
public MapRegisterBuilder addAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegister>> augmentationType,
                                          org.opendaylight.yangtools.yang.binding.Augmentation<MapRegister> augmentationValue)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use either addAugmentation(Augmentation) or removeAugmentation(Class) instead.
        Add or remove an augmentation to this builder's product.
        Parameters:
        augmentationType - augmentation type to be added or removed
        augmentationValue - augmentation value, null if the augmentation type should be removed
        Returns:
        this builder

      • removeAugmentation

        public MapRegisterBuilder removeAugmentation​(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegister>> 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 MapRegister build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<MapRegister>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<MapRegister,​java.lang.IllegalArgumentException>