Package org.apache.jorphan.io

Class TextFile

  • All Implemented Interfaces:
    java.io.Serializable , java.lang.Comparable 
    
public class TextFile
extends File

    Utility class to handle text files as a single lump of text.

    Note this is just as memory-inefficient as handling a text file can be. Use with restraint.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description
      TextFile(File filename, String encoding) Create a TextFile object to handle the named file with the given encoding.
      TextFile(File filename) Create a TextFile object to handle the named file with the platform default encoding.
      TextFile(String filename) Create a TextFile object to handle the named file with the platform default encoding.
      TextFile(String filename, String encoding) Create a TextFile object to handle the named file with the given encoding.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      String getEncoding() Returns encoding being used to read and write this file.
      void setEncoding(String string) Configures encoding to be used to read and write this file.
      void setText(String body) Create the file with the given string as content -- or replace its content with the given string if the file already existed.
      String getText() Read the whole file content and return it as a string.
      int hashCode()
      boolean equals(Object obj)

      • Methods inherited from class java.io.File

        canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, delete, deleteOnExit, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setLastModified, setReadOnly, setReadable, setWritable, toPath, toString, toURI, toURL

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TextFile

        TextFile(File filename, String encoding)
        Create a TextFile object to handle the named file with the given encoding.
        Parameters:
        filename - File to be read and written through this object.
        encoding - Encoding to be used when reading and writing this file.

      • TextFile

        TextFile(File filename)
        Create a TextFile object to handle the named file with the platform default encoding.
        Parameters:
        filename - File to be read and written through this object.

      • TextFile

        TextFile(String filename)
        Create a TextFile object to handle the named file with the platform default encoding.
        Parameters:
        filename - Name of the file to be read and written through this object.

      • TextFile

        TextFile(String filename, String encoding)
        Create a TextFile object to handle the named file with the given encoding.
        Parameters:
        filename - Name of the file to be read and written through this object.
        encoding - Encoding to be used when reading and writing this file.

    • Method Detail

      • getEncoding

         String getEncoding()

        Returns encoding being used to read and write this file.

        Returns:

        Encoding being used to read and write this file.

      • setEncoding

         void setEncoding(String string)

        Configures encoding to be used to read and write this file.

        Parameters:
        string - Encoding to be used to read and write this file.

      • setText

         void setText(String body)

        Create the file with the given string as content -- or replace its content with the given string if the file already existed.

        Parameters:
        body - New content for the file.

      • getText

         String getText()

        Read the whole file content and return it as a string.

        Returns:

        the content of the file