ea2ddl-gen/dbflute/templates/om/java/allcommon/helper/token/file/FileToken.vm

   1 ${database.allClassCopyright}package ${glPackageBaseCommonHelperTokenFile};\r
   2 \r
   3 /**\r
   4  * File-Token.\r
   5  * \r
   6  * @author ${database.ClassAuthor}\r
   7  */\r
   8 public interface ${glFileTokenName} {\r
   9 \r
  10     /**\r
  11      * Tokenize token-file data of a specified file.\r
  12      * \r
  13      * @param filename Input target file name. (NotNull)\r
  14      * @param fileTokenizingCallback File-tokenizing callback. (NotNull)\r
  15      * @param fileTokenizingOption File-tokenizing option. (NotNull and Required{encoding and delimiter})\r
  16      * @throws java.io.FileNotFoundException\r
  17      * @throws java.io.IOException\r
  18      */\r
  19     public void tokenize(String filename, ${glFileTokenizingCallbackName} fileTokenizingCallback, ${glFileTokenizingOptionName} fileTokenizingOption) throws java.io.FileNotFoundException, java.io.IOException;\r
  20 \r
  21     /**\r
  22      * Tokenize token-file data of a specified file.\r
  23      * <pre>\r
  24      * This method uses java.io.InputStreamReader and java.io.BufferedReader that wrap the argument[inputStream].\r
  25      * These objects are closed. (Invoking close() at finally)\r
  26      * </pre>\r
  27      * @param inputStream Input target stream. (NotNull)\r
  28      * @param fileTokenizingCallback File-tokenizing callback. (NotNull)\r
  29      * @param fileTokenizingOption File-tokenizing option. (NotNull and Required{encoding and delimiter})\r
  30      * @throws java.io.FileNotFoundException\r
  31      * @throws java.io.IOException\r
  32      */\r
  33     public void tokenize(java.io.InputStream inputStream, ${glFileTokenizingCallbackName} fileTokenizingCallback, ${glFileTokenizingOptionName} fileTokenizingOption) throws java.io.FileNotFoundException, java.io.IOException;\r
  34 \r
  35     /**\r
  36      * Make token-file from specified row resources.\r
  37      * \r
  38      * @param filename Output target file name. (NotNull)\r
  39      * @param fileMakingCallback File-making callback. (NotNull)\r
  40      * @param fileMakingOption File-making option. (NotNull and Required{encoding and delimiter})\r
  41      * @throws java.io.FileNotFoundException\r
  42      * @throws java.io.IOException\r
  43      */\r
  44     public void make(String filename, ${glFileMakingCallbackName} fileMakingCallback, ${glFileMakingOptionName} fileMakingOption) throws java.io.FileNotFoundException, java.io.IOException;\r
  45 \r
  46     /**\r
  47      * Make token-file from specified row resources.\r
  48      * <pre>\r
  49      * This method uses java.io.BufferedOutputStream and java.io.OutputStreamWriter that wrap the argument[outputStream].\r
  50      * These objects are closed. (Invoking close() at finally)\r
  51      * </pre>\r
  52      * @param outputStream Output target stream. (NotNull)\r
  53      * @param fileMakingCallback File-making callback. (NotNull)\r
  54      * @param fileMakingOption File-making option. (NotNull and Required{encoding and delimiter})\r
  55      * @throws java.io.FileNotFoundException\r
  56      * @throws java.io.IOException\r
  57      */\r
  58     public void make(java.io.OutputStream outputStream, ${glFileMakingCallbackName} fileMakingCallback, ${glFileMakingOptionName} fileMakingOption) throws java.io.FileNotFoundException, java.io.IOException;\r
  59 }