Class WriterFactory

java.lang.Object
org.apache.maven.shared.utils.WriterFactory

public class WriterFactory extends Object
Utility to create Writers, with explicit encoding choice: platform default, XML, or specified.
See Also:
  • Field Details

    • ISO_8859_1

      @Deprecated public static final String ISO_8859_1
      Deprecated.
      use java.nio.charset.StandardCharset.ISO_8859_1
      ISO Latin Alphabet #1, also known as ISO-LATIN-1. Every implementation of the Java platform is required to support this character encoding.
      See Also:
    • US_ASCII

      @Deprecated public static final String US_ASCII
      Deprecated.
      use java.nio.charset.StandardCharset.US_ASCII
      Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set. Every implementation of the Java platform is required to support this character encoding.
      See Also:
    • UTF_16

      @Deprecated public static final String UTF_16
      Deprecated.
      use java.nio.charset.StandardCharset.UTF_16
      Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order accepted on input, big-endian used on output). Every implementation of the Java platform is required to support this character encoding.
      See Also:
    • UTF_16BE

      @Deprecated public static final String UTF_16BE
      Deprecated.
      use java.nio.charset.StandardCharset.UTF_16BE
      Sixteen-bit Unicode Transformation Format, big-endian byte order. Every implementation of the Java platform is required to support this character encoding.
      See Also:
    • UTF_16LE

      @Deprecated public static final String UTF_16LE
      Deprecated.
      use java.nio.charset.StandardCharset.UTF_16LE
      Sixteen-bit Unicode Transformation Format, little-endian byte order. Every implementation of the Java platform is required to support this character encoding.
      See Also:
    • UTF_8

      @Deprecated public static final String UTF_8
      Deprecated.
      use java.nio.charset.StandardCharset.UTF_8
      Eight-bit Unicode Transformation Format. Every implementation of the Java platform is required to support this character encoding.
      See Also:
    • FILE_ENCODING

      public static final String FILE_ENCODING
      The file.encoding System Property.
  • Constructor Details

    • WriterFactory

      public WriterFactory()
  • Method Details

    • newXmlWriter

      public static XmlStreamWriter newXmlWriter(@Nonnull OutputStream out) throws IOException
      Create a new Writer with XML encoding detection rules.
      Parameters:
      out - not null output stream
      Returns:
      an XML writer instance for the output stream
      Throws:
      IOException - if any
      See Also:
    • newXmlWriter

      public static XmlStreamWriter newXmlWriter(@Nonnull File file) throws IOException
      Create a new Writer with XML encoding detection rules.
      Parameters:
      file - not null file
      Returns:
      an XML writer instance for the output file
      Throws:
      IOException - if any
      See Also:
    • newPlatformWriter

      @Deprecated public static Writer newPlatformWriter(@Nonnull OutputStream out)
      Deprecated.
      always specify an encoding. Do not depend on the default platform character set.
      Create a new Writer with default platform encoding.
      Parameters:
      out - not null output stream
      Returns:
      a writer instance for the output stream using the default platform charset
    • newPlatformWriter

      @Deprecated public static Writer newPlatformWriter(@Nonnull File file) throws IOException
      Deprecated.
      always specify an encoding. Do not depend on the default platform character set.
      Create a new Writer with default platform encoding.
      Parameters:
      file - not null file
      Returns:
      a writer instance for the output file using the default platform charset
      Throws:
      IOException - if any
    • newWriter

      public static Writer newWriter(@Nonnull OutputStream out, @Nonnull String encoding) throws UnsupportedEncodingException
      Create a new Writer with specified encoding.
      Parameters:
      out - not null output stream
      encoding - not null supported encoding
      Returns:
      a writer instance for the output stream using the given encoding
      Throws:
      UnsupportedEncodingException - if any
      See Also:
    • newWriter

      public static Writer newWriter(@Nonnull File file, @Nonnull String encoding) throws UnsupportedEncodingException, FileNotFoundException
      Create a new Writer with specified encoding.
      Parameters:
      file - not null file
      encoding - not null supported encoding
      Returns:
      a writer instance for the output file using the given encoding
      Throws:
      UnsupportedEncodingException - if any
      FileNotFoundException - if any
      See Also: