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

Class MapRequestBuilder

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

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

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

    • Constructor Detail

      • MapRequestBuilder

        public MapRequestBuilder()

      • MapRequestBuilder

        public MapRequestBuilder​(MapRequest arg)

      • MapRequestBuilder

        public MapRequestBuilder​(EidList arg)

      • MapRequestBuilder

        public MapRequestBuilder​(MapRequest 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.EidList
        • org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRequestMetadata
        • org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRequest
        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.

      • getEidItem

        public java.util.List<EidItem> getEidItem()

      • getItrRloc

        public java.util.List<ItrRloc> getItrRloc()

      • getMapDataPresent

        public java.lang.Boolean getMapDataPresent()

      • isMapDataPresent

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

      • getMapReply

        public MapReply getMapReply()

      • getNonce

        public java.lang.Long getNonce()

      • getPitr

        public java.lang.Boolean getPitr()

      • isPitr

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

      • getProbe

        public java.lang.Boolean getProbe()

      • isProbe

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

      • getSmr

        public java.lang.Boolean getSmr()

      • isSmr

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

      • getSmrInvoked

        public java.lang.Boolean getSmrInvoked()

      • isSmrInvoked

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

      • getSourceEid

        public SourceEid getSourceEid()

      • augmentation

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

      • setAuthoritative

        public MapRequestBuilder setAuthoritative​(java.lang.Boolean value)

      • setMapDataPresent

        public MapRequestBuilder setMapDataPresent​(java.lang.Boolean value)

      • setSmrInvoked

        public MapRequestBuilder setSmrInvoked​(java.lang.Boolean value)

      • addAugmentation

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