Interface WoolFileLoader

  • All Known Implementing Classes:
    WoolResourceFileLoader

    public interface WoolFileLoader
    A WOOL file loader is used by a WoolProjectParser to list and open WOOL dialogue files (.wool) and translation files (.json) within a WOOL project. The default implementation is WoolResourceFileLoader, which can load files from resources on the classpath.
    • Method Detail

      • listWoolFiles

        List<WoolFileDescription> listWoolFiles()
                                         throws IOException
        Lists all WOOL files in the project. The files should be dialogue files (.wool) or translation files (.json).
        Returns:
        the files
        Throws:
        IOException - if a reading error occurs
      • openFile

        Reader openFile​(WoolFileDescription descr)
                 throws IOException
        Opens the specified WOOL file. This should be a dialogue file (.wool) or a translation file (.json).
        Parameters:
        descr - the file description
        Returns:
        the reader for the file
        Throws:
        IOException - if the file cannot be opened