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

Class MapRegisterBuilder

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

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

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

    • MapRegisterBuilder

      public MapRegisterBuilder()
      Construct an empty builder.

    • MapRegisterBuilder

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

    • MapRegisterBuilder

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

    • MapRegisterBuilder

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

    • MapRegisterBuilder

      public MapRegisterBuilder(MapRegister base)
      Construct a builder initialized with state from specified MapRegister.
      Parameters:
      base - MapRegister 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 MapRegister.getAuthenticationData().
      Returns:
      current value

    • getKeyId

      public Short getKeyId()
      Return current value associated with the property corresponding to MapRegister.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 MapRegister.getMergeEnabled().
      Returns:
      current value

    • getNonce

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

    • getProxyMapReply

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

    • getSiteId

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

    • getWantMapNotify

      public Boolean getWantMapNotify()
      Return current value associated with the property corresponding to MapRegister.getWantMapNotify().
      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 MapRegister.getXtrSiteIdPresent().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegister>> 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 MapRegisterBuilder setAuthenticationData(byte[] value)
      Set the property corresponding to MapRegister.getAuthenticationData() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setKeyId

      public MapRegisterBuilder setKeyId(Short value)
      Set the property corresponding to MapRegister.getKeyId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMappingRecordItem

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

    • setMergeEnabled

      public MapRegisterBuilder setMergeEnabled(Boolean value)
      Set the property corresponding to MapRegister.getMergeEnabled() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNonce

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

    • setProxyMapReply

      public MapRegisterBuilder setProxyMapReply(Boolean value)
      Set the property corresponding to MapRegister.getProxyMapReply() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSiteId

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

    • setWantMapNotify

      public MapRegisterBuilder setWantMapNotify(Boolean value)
      Set the property corresponding to MapRegister.getWantMapNotify() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setXtrId

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

    • setXtrSiteIdPresent

      public MapRegisterBuilder setXtrSiteIdPresent(Boolean value)
      Set the property corresponding to MapRegister.getXtrSiteIdPresent() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

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

    • removeAugmentation

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