Class DocumentKey


  • public class DocumentKey
    extends Object
    This class encapsulates a string used as the value of the document-uri() property of a document, together with a normalized representation of the string used for equality comparisons. The idea is that on Windows systems, document URIs are compared using case-blind comparison, but the original case is retained for display purposes.

    The package name and version of the document reference are retained, because calls of doc() in different packages, using the same absolute URI, may return different documents, as a result of the treatment of whitespace and type annotations varying.

    • Field Detail

      • CASE_BLIND_FILES

        public static final boolean CASE_BLIND_FILES
    • Constructor Detail

      • DocumentKey

        public DocumentKey​(String uri)
        Create a DocumentURI object that wraps a given URI
        Parameters:
        uri - the URI to be wrapped. Must not be null
        Throws:
        NullPointerException - if uri is null
    • Method Detail

      • getAbsoluteURI

        public String getAbsoluteURI()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • normalizeURI

        public static String normalizeURI​(String uri)
        Normalize the representation of file: URIs to give better equality matching than straight string comparison. The main purpose is (a) to eliminate the distinction between "file:/" and "file:///", and (b) to normalize case in the case of Windows filenames: especially the distinction between "file:/C:" and "file:/c:".
        Parameters:
        uri - the URI to be normalized
        Returns:
        the normalized URI.