Interface TextFileOutputStreamFactory


public interface TextFileOutputStreamFactory
This is for use when creating user-facing/user-readable text-based files.

On some platforms, text files need to be associated with a file encoding. TextFileOutputStream allows for the use of platform-specific utilities to associate the appropriate file encoding with newly created files.

By using the TextFileOutputStreamFactory to create text-based output streams, you can ensure that your file will be readable by users on all platforms.

  • Method Details

    • createOutputStream

      FileOutputStream createOutputStream(File file) throws IOException
      Creates a file output stream to write to the file represented by the specified File object. A new FileDescriptor object is created to represent this file connection. First, if there is a security manager, its checkWrite method is called with the path represented by the file argument as its argument.

      If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

      Parameters:
      file - the file to be opened for writing.
      Throws:
      IOException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason
      SecurityException - if a security manager exists and its checkWrite method denies write access to the file.
      See Also:
    • createOutputStream

      FileOutputStream createOutputStream(File file, boolean append) throws IOException
      Creates a file output stream to write to the file represented by the specified File object. A new FileDescriptor object is created to represent this file connection. First, if there is a security manager, its checkWrite method is called with the path represented by the file argument as its argument.

      If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

      Parameters:
      file - the file to be opened for writing.
      append - if true, then bytes will be written to the end of the file rather than the beginning
      Throws:
      IOException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason
      SecurityException - if a security manager exists and its checkWrite method denies write access to the file.
      See Also:
    • createOutputStream

      FileOutputStream createOutputStream(String name) throws IOException
      Creates an output file stream to write to the file with the specified name. A new FileDescriptor object is created to represent this file connection. First, if there is a security manager, its checkWrite method is called with name as its argument.

      If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

      Parameters:
      name - the system-dependent filename
      Throws:
      IOException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason
      SecurityException - if a security manager exists and its checkWrite method denies write access to the file.
      See Also:
    • createOutputStream

      FileOutputStream createOutputStream(String name, boolean append) throws IOException
      Creates an output file stream to write to the file with the specified name. A new FileDescriptor object is created to represent this file connection. First, if there is a security manager, its checkWrite method is called with name as its argument.

      If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason then a FileNotFoundException is thrown.

      Parameters:
      name - the system-dependent filename
      append - if true, then bytes will be written to the end of the file rather than the beginning
      Throws:
      IOException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason
      SecurityException - if a security manager exists and its checkWrite method denies write access to the file.
      See Also: