com.ibm.wsspi.logging

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 Summary

      Methods 
      Modifier and Type Method and Description
      java.io.FileOutputStream createOutputStream(java.io.File file)
      Creates a file output stream to write to the file represented by the specified File object.
      java.io.FileOutputStream createOutputStream(java.io.File file, boolean append)
      Creates a file output stream to write to the file represented by the specified File object.
      java.io.FileOutputStream createOutputStream(java.lang.String name)
      Creates an output file stream to write to the file with the specified name.
      java.io.FileOutputStream createOutputStream(java.lang.String name, boolean append)
      Creates an output file stream to write to the file with the specified name.
    • Method Detail

      • createOutputStream

        java.io.FileOutputStream createOutputStream(java.io.File file)
                                                    throws java.io.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:
        java.io.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
        java.lang.SecurityException - if a security manager exists and its checkWrite method denies write access to the file.
        See Also:
        FileOutputStream.FileOutputStream(File)
      • createOutputStream

        java.io.FileOutputStream createOutputStream(java.io.File file,
                                                  boolean append)
                                                    throws java.io.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:
        java.io.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
        java.lang.SecurityException - if a security manager exists and its checkWrite method denies write access to the file.
        See Also:
        FileOutputStream.FileOutputStream(File, boolean)
      • createOutputStream

        java.io.FileOutputStream createOutputStream(java.lang.String name)
                                                    throws java.io.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:
        java.io.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
        java.lang.SecurityException - if a security manager exists and its checkWrite method denies write access to the file.
        See Also:
        FileOutputStream.FileOutputStream(String)
      • createOutputStream

        java.io.FileOutputStream createOutputStream(java.lang.String name,
                                                  boolean append)
                                                    throws java.io.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:
        java.io.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
        java.lang.SecurityException - if a security manager exists and its checkWrite method denies write access to the file.
        See Also:
        FileOutputStream.FileOutputStream(String, boolean)