Interface IJavaReferenceMapping<ReferenceType>

Type Parameters:
ReferenceType - the type of the reference this mapping points to.
All Known Subinterfaces:
IJavaElementMapping<ReferenceType>, IJavaURIMapping
All Known Implementing Classes:
AbstractBaseJavaReferenceMapping, JavaElementMapping, JavaURIMapping

public interface IJavaReferenceMapping<ReferenceType>
A mapping from an identifier to something else. The "something else" is defined by subclasses of this interface. Implementors of such subclasses are used during the process of resolving references where identifiers need to be mapped to other objects. This interface must not be implemented by clients.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the identifier that is mapped.
    Returns the mapped target.
    A mapping can have a warning attached that contains additional information (e.g., when the mapping might be wrong under specific conditions).
  • Method Details

    • getIdentifier

      String getIdentifier()
      Returns the identifier that is mapped.
      Returns:
      the identifier.
    • getTarget

      ReferenceType getTarget()
      Returns the mapped target.
      Returns:
      the target.
    • getWarning

      String getWarning()
      A mapping can have a warning attached that contains additional information (e.g., when the mapping might be wrong under specific conditions). The warning is meant to be presented to the user together with the mapping result.
      Returns:
      the warning.