123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211 |
- /*
- * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes
- *
- * 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 com.dmdirc.util;
-
- import java.io.BufferedReader;
- import java.io.BufferedWriter;
- import java.io.File;
- import java.io.FileInputStream;
- import java.io.FileWriter;
- import java.io.IOException;
- import java.io.InputStream;
- import java.io.InputStreamReader;
- import java.nio.charset.Charset;
- import java.util.ArrayList;
- import java.util.List;
-
- /**
- * Allows reading and writing to a plain text file via a list of lines.
- *
- * @author chris
- */
- public class TextFile {
-
- /** The file we're dealing with. */
- private File file;
-
- /** The input stream we're dealing with. */
- private InputStream is;
-
- /** The lines we've read from the file. */
- private List<String> lines;
-
- /** The charset to use to read the file. */
- private final Charset charset;
-
- /**
- * Creates a new instance of TextFile for the specified file, and uses the
- * default charset.
- *
- * @param filename The file to be read/written
- */
- public TextFile(final String filename) {
- this(new File(filename));
- }
-
- /**
- * Creates a new instance of TextFile for the specified File, and uses the
- * default charset.
- *
- * @param file The file to read
- */
- public TextFile(final File file) {
- this(file, Charset.defaultCharset());
- }
-
- /**
- * Creates a new instance of TextFile for an input stream, and uses the
- * default charset.
- *
- * @param is The input stream to read from
- */
- public TextFile(final InputStream is) {
- this(is, Charset.defaultCharset());
- }
-
- /**
- * Creates a new instance of TextFile for the specified File, which is to
- * be read using the specified charset.
- *
- * @param file The file to read
- * @param charset The charset to read the file in
- * @since 0.6.3m1
- */
- public TextFile(final File file, final Charset charset) {
- this.file = file;
- this.charset = charset;
- }
-
- /**
- * Creates a new instance of TextFile for an input stream, which is to
- * be read using the specified charset.
- *
- * @param is The input stream to read from
- * @param charset The charset to read the file in
- * @since 0.6.3m1
- */
- public TextFile(final InputStream is, final Charset charset) {
- this.is = is;
- this.charset = charset;
- }
-
- /**
- * Retrieves the contents of the file as a list of lines. If getLines() or
- * readLines() has previously been called, a cached version is returned.
- *
- * @return A list of lines in the file
- * @throws IOException if an I/O exception occurs
- */
- public List<String> getLines() throws IOException {
- if (lines == null) {
- readLines();
- }
-
- return lines;
- }
-
- /**
- * Reads the contents of the file into this TextFile's line cache.
- *
- * @throws IOException If an I/O exception occurs
- */
- public void readLines() throws IOException {
- BufferedReader reader = null;
- InputStreamReader inputReader = null;
- InputStream inputStream = null;
-
- try {
- inputStream = file == null ? is : new FileInputStream(file);
- inputReader = new InputStreamReader(inputStream, charset);
- reader = new BufferedReader(inputReader);
- lines = new ArrayList<String>();
-
- String line;
-
- while ((line = reader.readLine()) != null) {
- lines.add(line);
- }
- } finally {
- StreamUtil.close(reader);
- StreamUtil.close(inputReader);
- StreamUtil.close(inputStream);
- }
- }
-
- /**
- * Determines if this file is writable or not.
- *
- * @return True if the file is writable, false otherwise
- */
- public boolean isWritable() {
- return file != null;
- }
-
- /**
- * Writes the specified list of lines to the file.
- *
- * @param lines The lines to be written
- * @throws IOException if an I/O exception occurs
- */
- public void writeLines(final List<String> lines) throws IOException {
- if (file == null) {
- throw new UnsupportedOperationException("Cannot write to TextFile "
- + "opened with an InputStream");
- }
-
- BufferedWriter writer = null;
-
- try {
- writer = new BufferedWriter(new FileWriter(file));
-
- for (String line : lines) {
- writer.write(line);
- writer.newLine();
- }
- } finally {
- StreamUtil.close(writer);
- }
- }
-
- /**
- * Retrieves the File for this TextFile, if there is one.
- *
- * @return This TextFile's file, or null
- */
- public File getFile() {
- return file;
- }
-
- /**
- * Deletes the file associated with this textfile, if there is one.
- */
- public void delete() {
- if (file == null) {
- throw new UnsupportedOperationException("Cannot delete TextFile "
- + "opened with an InputStream");
- }
-
- file.delete();
- }
-
- }
|