org.riversun.file_grabber.TextFileReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of file-grabber Show documentation
Easy to read and write text files
The newest version!
/*
 * file-grabber Java lib for easy to handle and manipulate the text file
 *
 * Copyright (c) 2006-2016 Tom Misawa, [email protected]
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 * 
 */
package org.riversun.file_grabber;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * Read text from file/inputStream easily
 * 
 * @author Tom Misawa ([email protected])
 *
 */
public class TextFileReader {

  /**
   * Read whole text char by char
   * 
   * @param file
   * @return
   * @throws IOException
   */
  public String readTextCharByChar(File file) throws IOException {
    return readTextCharByChar(file, null);
  }

  /**
   * Read whole text from file char by char
   * 
   * @param file
   * @param charset
   *          specify character set like 'UTF-8'
   * @return
   * @throws IOException
   */
  public String readTextCharByChar(File file, String charset) throws IOException {

    FileInputStream fis = null;

    fis = new FileInputStream(file);

    return readTextCharByChar(fis, charset);

  }

  /**
   * Read whole text from input stream char by char
   * 
   * @param is
   * @param charset
   *          specify character set like 'UTF-8'
   * @return
   * @throws IOException
   */
  public String readTextCharByChar(InputStream is, String charset) throws IOException {

    final StringBuilder sb = new StringBuilder();

    InputStreamReader isr = null;
    BufferedReader br = null;

    try {

      if (isNotBlank(charset)) {
        isr = new InputStreamReader(is, charset);
      } else {
        isr = new InputStreamReader(is);
      }

      br = new BufferedReader(isr);

      int iChar = br.read();

      while (iChar != -1) {
        sb.append((char) iChar);
        iChar = br.read();
      }

    } finally {

      if (br != null) {
        try {
          br.close();
        } catch (IOException e) {
        }
      }
      if (isr != null) {
        try {
          isr.close();
        } catch (IOException e) {
        }
      }
      if (is != null) {
        try {
          is.close();
        } catch (IOException e) {
        }
      }
    }
    return sb.toString();

  }

  /**
   * Read whole text from file line by line
   * 
   * @param file
   * @return
   * @throws IOException
   */
  public String readText(File file) throws IOException {
    return readText(file, null);
  }

  /**
   * Read whole text from file char by char
   * 
   * @param file
   * @param charset
   *          specify character set like 'UTF-8'
   * @return
   * @throws IOException
   */
  public String readText(File file, String charset) throws IOException {
    return readTextCharByChar(file, charset);
  }

  /**
   * Read whole text from file char by char
   * 
   * @param is
   * @param charset
   * @return
   * @throws IOException
   */
  public String readText(InputStream is, String charset) throws IOException {
    return readTextCharByChar(is, charset);
  }

  /**
   * Read whole text from resource directory as UTF-8
   * 
   * @param fileName
   * @param charset
   * @return
   * @throws IOException
   */
  public String readTextFromResourceAsUTF8(String fileName) throws IOException {
    return readTextFromResource(fileName, StandardCharsets.UTF_8.toString());
  }

  /**
   * Read whole text from resource directory
   * 
   * @param fileName
   * @param charset
   * @return
   * @throws IOException
   */
  public String readTextFromResource(String fileName, String charset) throws IOException {
    final InputStream is = TextFileReader.class.getClassLoader().getResourceAsStream(fileName);
    return readText(is, charset);
  }

  /**
   * Read whole text from resource directory
   * 
   * @param clazz
   * @param fileName
   * @param charset
   * @return
   * @throws IOException
   *           

   *           
   * Example
   * tr.readTextFromResource(this.getClass(),"res.properties","UTF-8");
   * 
   */
  public String readTextFromResource(Class clazz, String fileName, String charset) throws IOException {
    final InputStream is = clazz.getResourceAsStream(fileName);
    return readText(is, charset);
  }

  /**
   * Read whole text from resource directory as List
   * 
   * @param clazz
   * @param fileName
   * @param charset
   * @return
   * @throws IOException
   */
  public List readTextAsListFromResource(Class clazz, String fileName, String charset, String newLine) throws IOException {
    String text = readTextFromResource(clazz, fileName, charset);
    String[] lines = text.split(newLine);
    return Arrays.asList(lines);

  }

  /**
   * Read whole text as list from file line by line
   * 
   * @param file
   * @return
   * @throws IOException
   */
  public List readTextAsList(File file) throws IOException {
    return readTextAsList(file, null);
  }

  /**
   * Read text as list from file line by line with range
   * 
   * @param file
   * @param beginLineNum
   *          line number starts with 0
   * @param endLineNum
   * @return
   * @throws IOException
   */
  public List readTextAsListWithRange(File file, int beginLineNum, int endLineNum) throws IOException {
    return readTextAsListWithRange(file, null, beginLineNum, endLineNum);
  }

  /**
   * Read whole text as list from file line by line
   * 
   * @param file
   * @param charset
   *          specify character set like 'UTF-8'
   * @return
   * @throws IOException
   */
  public List readTextAsList(File file, String charset) throws IOException {

    FileInputStream fis = new FileInputStream(file);

    return readTextAsList(fis, charset);

  }

  /**
   * Read text as list from file line by line with range
   * 
   * @param file
   * @param charset
   *          specify character set like 'UTF-8'
   * @param beginLineNum
   *          line number starts with 0
   * @param endLineNum
   * @return
   * @throws IOException
   */
  public List readTextAsListWithRange(File file, String charset, int beginLineNum, int endLineNum) throws IOException {

    FileInputStream fis = new FileInputStream(file);

    return readTextAsListWithRange(fis, charset, beginLineNum, endLineNum);

  }

  /**
   * Read whole text as list from inputStream line by line
   * 
   * @param is
   * @param charset
   * @return
   * @throws IOException
   */
  public List readTextAsList(InputStream is, String charset) throws IOException {
    return readTextAsListWithRange(is, charset, -1, -1);
  }

  /**
   * Read text as list from inputStream line by line with range
   * 
   * @param is
   * @param charset
   * @param beginLineNum
   *          line number starts with 0
   * @param endLineNum
   * @return
   * @throws IOException
   */
  public List readTextAsListWithRange(InputStream is, String charset, int beginLineNum, int endLineNum) throws IOException {

    long crrReadingLineNum = 0;

    final List lineList = new ArrayList();

    if (beginLineNum < 0) {
      beginLineNum = 0;
    }

    if (beginLineNum > endLineNum) {
      return lineList;
    }

    InputStreamReader isr = null;
    BufferedReader br = null;

    try {

      if (isNotBlank(charset)) {
        isr = new InputStreamReader(is, charset);
      } else {
        isr = new InputStreamReader(is);
      }

      br = new BufferedReader(isr);

      String line;

      while ((line = br.readLine()) != null) {

        boolean isSkip = false;
        boolean isFinish = false;

        if (beginLineNum <= crrReadingLineNum) {
          isSkip = false;
        } else {
          isSkip = true;
        }

        if (crrReadingLineNum <= endLineNum || endLineNum < 0) {
          isFinish = false;
        } else {
          isFinish = true;
        }

        if (isFinish) {
          break;
        }
        if (isSkip) {

        } else {
          lineList.add(line);
        }

        crrReadingLineNum++;

      }

    } finally {
      if (br != null) {
        try {
          br.close();
        } catch (IOException e) {
        }
      }
      if (isr != null) {
        try {
          isr.close();
        } catch (IOException e) {
        }
      }
      if (is != null) {
        try {
          is.close();
        } catch (IOException e) {
        }
      }
    }
    return lineList;
  }

  /**
   * Returns true if string is not NULL and if length greater than 0.
   * 
   * @param str
   * @return
   */
  private boolean isNotBlank(String str) {

    if (str != null && !str.isEmpty()) {
      return true;
    }
    return false;
  }
}