Ignore:
Timestamp:
09/09/11 23:52:51 (13 years ago)
Author:
sherbold
Message:
  • code documentation and formatting
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/JavaHelperLib/src/de/ugoe/cs/util/FileTools.java

    r83 r175  
    66import java.io.IOException; 
    77 
     8/** 
     9 * <p> 
     10 * Helper class that provides methods that simplify working with files. 
     11 * </p> 
     12 *  
     13 * @author Steffen Herbold 
     14 * @version 1.0 
     15 */ 
    816public class FileTools { 
    9          
     17 
    1018        /** 
    1119         * <p> 
    12          * Returns an array of the lines contained in a file. The line seperator is "\r\n". 
     20         * Returns an array of the lines contained in a file. The line separator is 
     21         * "\r\n". 
    1322         * </p> 
    14          * @param filename name of the file 
     23         *  
     24         * @param filename 
     25         *            name of the file 
    1526         * @return string array, where each line contains a file 
    16          * @throws IOException see {@link FileReader#read(char[])}, {@link FileReader#close()}  
    17          * @throws FileNotFoundException see {@link FileReader#FileReader(File)} 
     27         * @throws IOException 
     28         *             see {@link FileReader#read(char[])}, 
     29         *             {@link FileReader#close()} 
     30         * @throws FileNotFoundException 
     31         *             see {@link FileReader#FileReader(File)} 
    1832         */ 
    19         public static String[] getLinesFromFile(String filename) throws IOException, FileNotFoundException { 
     33        public static String[] getLinesFromFile(String filename) 
     34                        throws IOException, FileNotFoundException { 
    2035                return getLinesFromFile(filename, true); 
    2136        } 
    22          
     37 
    2338        /** 
    2439         * <p> 
    2540         * Returns an array of the lines contained in a file. 
    2641         * </p> 
    27          * @param filename name of the file 
    28          * @param carriageReturn if true, "\r\n", if false "\n" is used as line seperator 
     42         *  
     43         * @param filename 
     44         *            name of the file 
     45         * @param carriageReturn 
     46         *            if true, "\r\n", if false "\n" is used as line separator 
    2947         * @return string array, where each line contains a file 
    30          * @throws IOException see {@link FileReader#read(char[])}, {@link FileReader#close()}  
    31          * @throws FileNotFoundException see {@link FileReader#FileReader(File)} 
     48         * @throws IOException 
     49         *             see {@link FileReader#read(char[])}, 
     50         *             {@link FileReader#close()} 
     51         * @throws FileNotFoundException 
     52         *             see {@link FileReader#FileReader(File)} 
    3253         */ 
    33         public static String[] getLinesFromFile(String filename, boolean carriageReturn) throws IOException, FileNotFoundException { 
     54        public static String[] getLinesFromFile(String filename, 
     55                        boolean carriageReturn) throws IOException, FileNotFoundException { 
    3456                File f = new File(filename); 
    3557                FileReader reader = new FileReader(f); 
    … …  
    3860                reader.close(); 
    3961                String splitString; 
    40                 if( carriageReturn ) { 
     62                if (carriageReturn) { 
    4163                        splitString = "\r\n"; 
    4264                } else { 
Note: See TracChangeset for help on using the changeset viewer.