All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Mapping>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<DbInstance>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<MappingKey>, MappingRecordContainer

@Generated("mdsal-binding-generator") public interface Mapping extends org.opendaylight.yangtools.yang.binding.ChildOf<DbInstance>, org.opendaylight.yangtools.yang.binding.Augmentable<Mapping>, MappingRecordContainer, org.opendaylight.yangtools.yang.binding.Identifiable<MappingKey>
A list of EID-to-RLOC mappings within the same Instance ID

This class represents the following YANG schema fragment defined in module odl-mappingservice

 list mapping {
   key "eid-uri origin";
   ext:context-instance eid-context;
   leaf eid-uri {
     type eid-uri;
   }
   leaf origin {
     type mapping-origin;
   }
   leaf-list site-id {
     type lisp-proto:site-id;
   }
   uses lisp-proto:mapping-record-container;
   list xtr-id-mapping {
     config false;
     key xtr-id-uri;
     ext:context-instance xtrid-context;
     leaf xtr-id-uri {
       type xtr-id-uri;
     }
     uses lisp-proto:mapping-record-container;
   }
 }
 

To create instances of this class use MappingBuilder.

See Also:
  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.
  • Method Details

    • implementedInterface

      default Class<Mapping> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      Specified by:
      implementedInterface in interface MappingRecordContainer
    • bindingHashCode

      static int bindingHashCode(@NonNull Mapping obj)
      Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
      Parameters:
      obj - Object for which to generate hashCode() result.
      Returns:
      Hash code value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null
    • bindingEquals

      static boolean bindingEquals(@NonNull Mapping thisObj, Object obj)
      Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
      Parameters:
      thisObj - Object acting as the receiver of equals invocation
      obj - Object acting as argument to equals invocation
      Returns:
      True if thisObj and obj are considered equal
      Throws:
      NullPointerException - if thisObj is null
    • bindingToString

      static String bindingToString(@NonNull Mapping obj)
      Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
      Parameters:
      obj - Object for which to generate toString() result.
      Returns:
      String value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null
    • key

      MappingKey key()
      Specified by:
      key in interface org.opendaylight.yangtools.yang.binding.Identifiable<MappingKey>
    • getEidUri

      EidUri getEidUri()
      Return eidUri, or null if it is not present.
      Returns:
      EidUri eidUri, or null if it is not present.
    • requireEidUri

      default @NonNull EidUri requireEidUri()
      Return eidUri, guaranteed to be non-null.
      Returns:
      EidUri eidUri, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if eidUri is not present
    • getOrigin

      MappingOrigin getOrigin()
      Return origin, or null if it is not present.
           
               Mapping origin
           
       
      Returns:
      MappingOrigin origin, or null if it is not present.
    • requireOrigin

      default @NonNull MappingOrigin requireOrigin()
      Return origin, guaranteed to be non-null.
           
               Mapping origin
           
       
      Returns:
      MappingOrigin origin, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if origin is not present
    • getSiteId

      @Nullable Set<SiteId> getSiteId()
      Return siteId, or null if it is not present.
           
               Site ID
           
       
      Returns:
      Set<SiteId> siteId, or null if it is not present.
    • requireSiteId

      default @NonNull Set<SiteId> requireSiteId()
      Return siteId, guaranteed to be non-null.
           
               Site ID
           
       
      Returns:
      Set<SiteId> siteId, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if siteId is not present
    • getXtrIdMapping

      @Nullable Map<XtrIdMappingKey,XtrIdMapping> getXtrIdMapping()
      Return xtrIdMapping, or null if it is not present.
           
               A list of xTR-IDs with their associated mappings
           
       
      Returns:
      Map<XtrIdMappingKey, XtrIdMapping> xtrIdMapping, or null if it is not present.
    • nonnullXtrIdMapping

      default @NonNull Map<XtrIdMappingKey,XtrIdMapping> nonnullXtrIdMapping()
      Return xtrIdMapping, or an empty list if it is not present.
      Returns:
      Map<XtrIdMappingKey, XtrIdMapping> xtrIdMapping, or an empty list if it is not present.