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

Class MapRequestBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.maprequestnotification.MapRequestBuilder
@Generated("mdsal-binding-generator") public class MapRequestBuilder extends Object
Class that builds MapRequest 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: 

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

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

  • Constructor Details

    • MapRequestBuilder

      public MapRequestBuilder()
      Construct an empty builder.

    • MapRequestBuilder

      public MapRequestBuilder(MapRequest arg)
      Construct a new builder initialized from specified MapRequest.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.MapRequest from which the builder should be initialized

    • MapRequestBuilder

      public MapRequestBuilder(EidList arg)
      Construct a new builder initialized from specified EidList.
      Parameters:
      arg - EidList from which the builder should be initialized

    • MapRequestBuilder

      public MapRequestBuilder(MapRequestMetadata arg)
      Construct a new builder initialized from specified MapRequestMetadata.
      Parameters:
      arg - MapRequestMetadata from which the builder should be initialized

    • MapRequestBuilder

      public MapRequestBuilder(MapRequest base)
      Construct a builder initialized with state from specified MapRequest.
      Parameters:
      base - MapRequest from which the builder should be initialized

  • Method Details

    • 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:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • getAuthoritative

      public Boolean getAuthoritative()
      Return current value associated with the property corresponding to MapRequest.getAuthoritative().
      Returns:
      current value

    • getEidItem

      public List<EidItem> getEidItem()
      Return current value associated with the property corresponding to EidList.getEidItem().
      Returns:
      current value

    • getItrRloc

      public List<ItrRloc> getItrRloc()
      Return current value associated with the property corresponding to MapRequest.getItrRloc().
      Returns:
      current value

    • getMapDataPresent

      public Boolean getMapDataPresent()
      Return current value associated with the property corresponding to MapRequest.getMapDataPresent().
      Returns:
      current value

    • getMapReply

      public MapReply getMapReply()
      Return current value associated with the property corresponding to MapRequest.getMapReply().
      Returns:
      current value

    • getNonce

      public Long getNonce()
      Return current value associated with the property corresponding to MapRequest.getNonce().
      Returns:
      current value

    • getPitr

      public Boolean getPitr()
      Return current value associated with the property corresponding to MapRequest.getPitr().
      Returns:
      current value

    • getProbe

      public Boolean getProbe()
      Return current value associated with the property corresponding to MapRequest.getProbe().
      Returns:
      current value

    • getSmr

      public Boolean getSmr()
      Return current value associated with the property corresponding to MapRequest.getSmr().
      Returns:
      current value

    • getSmrInvoked

      public Boolean getSmrInvoked()
      Return current value associated with the property corresponding to MapRequest.getSmrInvoked().
      Returns:
      current value

    • getSourceEid

      public SourceEid getSourceEid()
      Return current value associated with the property corresponding to MapRequest.getSourceEid().
      Returns:
      current value

    • getSourceRloc

      public IpAddressBinary getSourceRloc()
      Return current value associated with the property corresponding to MapRequestMetadata.getSourceRloc().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRequest>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      Parameters:
      augmentationType - augmentation type class
      Returns:
      Augmentation object from this builder, or null if not present
      Throws:
      NullPointerException - if augmentType is null

    • setAuthoritative

      public MapRequestBuilder setAuthoritative(Boolean value)
      Set the property corresponding to MapRequest.getAuthoritative() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setEidItem

      public MapRequestBuilder setEidItem(List<EidItem> values)
      Set the property corresponding to EidList.getEidItem() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setItrRloc

      public MapRequestBuilder setItrRloc(List<ItrRloc> values)
      Set the property corresponding to MapRequest.getItrRloc() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setMapDataPresent

      public MapRequestBuilder setMapDataPresent(Boolean value)
      Set the property corresponding to MapRequest.getMapDataPresent() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMapReply

      public MapRequestBuilder setMapReply(MapReply value)
      Set the property corresponding to MapRequest.getMapReply() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNonce

      public MapRequestBuilder setNonce(Long value)
      Set the property corresponding to MapRequest.getNonce() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPitr

      public MapRequestBuilder setPitr(Boolean value)
      Set the property corresponding to MapRequest.getPitr() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setProbe

      public MapRequestBuilder setProbe(Boolean value)
      Set the property corresponding to MapRequest.getProbe() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSmr

      public MapRequestBuilder setSmr(Boolean value)
      Set the property corresponding to MapRequest.getSmr() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSmrInvoked

      public MapRequestBuilder setSmrInvoked(Boolean value)
      Set the property corresponding to MapRequest.getSmrInvoked() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSourceEid

      public MapRequestBuilder setSourceEid(SourceEid value)
      Set the property corresponding to MapRequest.getSourceEid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSourceRloc

      public MapRequestBuilder setSourceRloc(IpAddressBinary value)
      Set the property corresponding to MapRequestMetadata.getSourceRloc() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • 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:
      NullPointerException - if augmentation is null

    • removeAugmentation

      public MapRequestBuilder removeAugmentation(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 @NonNull MapRequest build()
      A new MapRequest instance.
      Returns:
      A new MapRequest instance.