Interface UrlMessageBundle


  • @MessageLogger(projectCode="HHH")
    @ValidIdRange(min=10000001,
                  max=10001000)
    public interface UrlMessageBundle
    Acts as the MessageLogger and MessageBundle for messages related to processing URLs.
    • Method Detail

      • logMalformedUrl

        @LogMessage(level=WARN)
        @Message(value="Malformed URL: %s",
                 id=10000001)
        void logMalformedUrl​(URL jarUrl,
                             @Cause
                             URISyntaxException e)
        Logs a warning about a malformed URL, caused by a URISyntaxException
        Parameters:
        jarUrl - The URL that lead to the URISyntaxException
        e - The underlying URISyntaxException
      • logUnableToFindFileByUrl

        @LogMessage(level=WARN)
        @Message(value="File or directory named by URL [%s] could not be found.  URL will be ignored",
                 id=10000002)
        void logUnableToFindFileByUrl​(URL url,
                                      @Cause
                                      Exception e)
        Logs a warning about not being able to find a file by a specified URL. This is different from logFileDoesNotExist(java.net.URL).
        Parameters:
        url - The URL is supposed to identify the file which we cannot locate
        e - The underlying URISyntaxException
      • logFileDoesNotExist

        @LogMessage(level=WARN)
        @Message(value="File or directory named by URL [%s] did not exist.  URL will be ignored",
                 id=10000003)
        void logFileDoesNotExist​(URL url)
        Logs a warning that the File (file/directory) to which the URL resolved reported that it did not exist.
        Parameters:
        url - The URL that named the file/directory
        See Also:
        File.exists()
      • logFileIsNotDirectory

        @LogMessage(level=WARN)
        @Message(value="Expecting resource named by URL [%s] to be a directory, but it was not.  URL will be ignored",
                 id=10000004)
        void logFileIsNotDirectory​(URL url)
        Logs a warning indicating that the URL resolved to a File that we were expecting to be a directory, but File.isDirectory() reported it was not.
        Parameters:
        url - The URL that named the file/directory
        See Also:
        File.isDirectory()
      • fileDoesNotExist

        @Message(value="File [%s] referenced by given URL [%s] does not exist",
                 id=10000005)
        String fileDoesNotExist​(String filePart,
                                URL url)
        Access to the exception message used when a URL references names a file that does not exist.

        TODO : detail when this is a warning logFileDoesNotExist(java.net.URL) versus an exception...

        Parameters:
        filePart - The "file part" that we gleaned from the URL
        url - The given URL
        Returns:
        The message