java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapnotifymessage.MapNotifyBuilder

@Generated("mdsal-binding-generator") public class MapNotifyBuilder extends Object
Class that builds MapNotify 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:

   
     MapNotify createMapNotify(int fooXyzzy, int barBaz) {
         return new MapNotifyBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

    • MapNotifyBuilder

      public MapNotifyBuilder()
      Construct an empty builder.
    • MapNotifyBuilder

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

      public MapNotifyBuilder(MappingRecordList arg)
      Construct a new builder initialized from specified MappingRecordList.
      Parameters:
      arg - MappingRecordList from which the builder should be initialized
    • MapNotifyBuilder

      public MapNotifyBuilder(XtrSiteId arg)
      Construct a new builder initialized from specified XtrSiteId.
      Parameters:
      arg - XtrSiteId from which the builder should be initialized
    • MapNotifyBuilder

      public MapNotifyBuilder(MapNotify base)
      Construct a builder initialized with state from specified MapNotify.
      Parameters:
      base - MapNotify 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
    • getAuthenticationData

      public byte[] getAuthenticationData()
      Return current value associated with the property corresponding to MapNotify.getAuthenticationData().
      Returns:
      current value
    • getKeyId

      public Short getKeyId()
      Return current value associated with the property corresponding to MapNotify.getKeyId().
      Returns:
      current value
    • getMappingRecordItem

      public List<MappingRecordItem> getMappingRecordItem()
      Return current value associated with the property corresponding to MappingRecordList.getMappingRecordItem().
      Returns:
      current value
    • getMergeEnabled

      public Boolean getMergeEnabled()
      Return current value associated with the property corresponding to MapNotify.getMergeEnabled().
      Returns:
      current value
    • getNonce

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

      public SiteId getSiteId()
      Return current value associated with the property corresponding to XtrSiteId.getSiteId().
      Returns:
      current value
    • getXtrId

      public XtrId getXtrId()
      Return current value associated with the property corresponding to XtrSiteId.getXtrId().
      Returns:
      current value
    • getXtrSiteIdPresent

      public Boolean getXtrSiteIdPresent()
      Return current value associated with the property corresponding to MapNotify.getXtrSiteIdPresent().
      Returns:
      current value
    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapNotify>> 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
    • setAuthenticationData

      public MapNotifyBuilder setAuthenticationData(byte[] value)
      Set the property corresponding to MapNotify.getAuthenticationData() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setKeyId

      public MapNotifyBuilder setKeyId(Short value)
      Set the property corresponding to MapNotify.getKeyId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setMappingRecordItem

      public MapNotifyBuilder setMappingRecordItem(List<MappingRecordItem> values)
      Set the property corresponding to MappingRecordList.getMappingRecordItem() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder
    • setMergeEnabled

      public MapNotifyBuilder setMergeEnabled(Boolean value)
      Set the property corresponding to MapNotify.getMergeEnabled() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setNonce

      public MapNotifyBuilder setNonce(Long value)
      Set the property corresponding to MapNotify.getNonce() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setSiteId

      public MapNotifyBuilder setSiteId(SiteId value)
      Set the property corresponding to XtrSiteId.getSiteId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setXtrId

      public MapNotifyBuilder setXtrId(XtrId value)
      Set the property corresponding to XtrSiteId.getXtrId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • setXtrSiteIdPresent

      public MapNotifyBuilder setXtrSiteIdPresent(Boolean value)
      Set the property corresponding to MapNotify.getXtrSiteIdPresent() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder
    • addAugmentation

      public MapNotifyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MapNotify> 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 MapNotifyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapNotify>> 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 MapNotify build()
      A new MapNotify instance.
      Returns:
      A new MapNotify instance.