Class UnicodeInputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable

    public class UnicodeInputStream
    extends java.io.InputStream
    This is an input stream that is unicode BOM aware. This allows you to e.g. read Windows Notepad Unicode files as Velocity templates. It allows you to check the actual encoding of a file by calling getEncodingFromStream() on the input stream reader. This class is not thread safe! When more than one thread wants to use an instance of UnicodeInputStream, the caller must provide synchronization.
    Since:
    1.5
    Version:
    $Id: UnicodeInputStream.java 685685 2008-08-13 21:43:27Z nbubna $
    • Field Detail

      • UTF16LE_BOM

        public static final UnicodeInputStream.UnicodeBOM UTF16LE_BOM
        BOM Marker for UTF 16, little endian. See http://www.unicode.org/unicode/faq/utf_bom.html
      • UTF16BE_BOM

        public static final UnicodeInputStream.UnicodeBOM UTF16BE_BOM
        BOM Marker for UTF 16, big endian. See http://www.unicode.org/unicode/faq/utf_bom.html
      • UTF32LE_BOM

        public static final UnicodeInputStream.UnicodeBOM UTF32LE_BOM
        BOM Marker for UTF 32, little endian. See http://www.unicode.org/unicode/faq/utf_bom.html TODO: Does Java actually support this?
      • UTF32BE_BOM

        public static final UnicodeInputStream.UnicodeBOM UTF32BE_BOM
        BOM Marker for UTF 32, big endian. See http://www.unicode.org/unicode/faq/utf_bom.html TODO: Does Java actually support this?
      • MAX_BOM_SIZE

        private static final int MAX_BOM_SIZE
        The maximum amount of bytes to read for a BOM
        See Also:
        Constant Field Values
      • buf

        private byte[] buf
        Buffer for BOM reading
      • pos

        private int pos
        Buffer pointer.
      • encoding

        private final java.lang.String encoding
        The stream encoding as read from the BOM or null.
      • skipBOM

        private final boolean skipBOM
        True if the BOM itself should be skipped and not read.
      • inputStream

        private final java.io.PushbackInputStream inputStream
    • Constructor Detail

      • UnicodeInputStream

        public UnicodeInputStream​(java.io.InputStream inputStream)
                           throws java.lang.IllegalStateException,
                                  java.io.IOException
        Creates a new UnicodeInputStream object. Skips a BOM which defines the file encoding.
        Parameters:
        inputStream - The input stream to use for reading.
        Throws:
        java.lang.IllegalStateException
        java.io.IOException
      • UnicodeInputStream

        public UnicodeInputStream​(java.io.InputStream inputStream,
                                  boolean skipBOM)
                           throws java.lang.IllegalStateException,
                                  java.io.IOException
        Creates a new UnicodeInputStream object.
        Parameters:
        inputStream - The input stream to use for reading.
        skipBOM - If this is set to true, a BOM read from the stream is discarded. This parameter should normally be true.
        Throws:
        java.lang.IllegalStateException
        java.io.IOException
    • Method Detail

      • isSkipBOM

        public boolean isSkipBOM()
        Returns true if the input stream discards the BOM.
        Returns:
        True if the input stream discards the BOM.
      • getEncodingFromStream

        public java.lang.String getEncodingFromStream()
        Read encoding based on BOM.
        Returns:
        The encoding based on the BOM.
        Throws:
        java.lang.IllegalStateException - When a problem reading the BOM occured.
      • readEncoding

        protected java.lang.String readEncoding()
                                         throws java.io.IOException
        This method gets the encoding from the stream contents if a BOM exists. If no BOM exists, the encoding is undefined.
        Returns:
        The encoding of this streams contents as decided by the BOM or null if no BOM was found.
        Throws:
        java.io.IOException
      • readByte

        private final boolean readByte()
                                throws java.io.IOException
        Throws:
        java.io.IOException
      • close

        public void close()
                   throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.InputStream
        Throws:
        java.io.IOException
        See Also:
        InputStream.close()
      • available

        public int available()
                      throws java.io.IOException
        Overrides:
        available in class java.io.InputStream
        Throws:
        java.io.IOException
        See Also:
        InputStream.available()
      • mark

        public void mark​(int readlimit)
        Overrides:
        mark in class java.io.InputStream
        See Also:
        InputStream.mark(int)
      • markSupported

        public boolean markSupported()
        Overrides:
        markSupported in class java.io.InputStream
        See Also:
        InputStream.markSupported()
      • read

        public int read()
                 throws java.io.IOException
        Specified by:
        read in class java.io.InputStream
        Throws:
        java.io.IOException
        See Also:
        InputStream.read()
      • read

        public int read​(byte[] b)
                 throws java.io.IOException
        Overrides:
        read in class java.io.InputStream
        Throws:
        java.io.IOException
        See Also:
        InputStream.read(byte[])
      • read

        public int read​(byte[] b,
                        int off,
                        int len)
                 throws java.io.IOException
        Overrides:
        read in class java.io.InputStream
        Throws:
        java.io.IOException
        See Also:
        InputStream.read(byte[], int, int)
      • reset

        public void reset()
                   throws java.io.IOException
        Overrides:
        reset in class java.io.InputStream
        Throws:
        java.io.IOException
        See Also:
        InputStream.reset()
      • skip

        public long skip​(long n)
                  throws java.io.IOException
        Overrides:
        skip in class java.io.InputStream
        Throws:
        java.io.IOException
        See Also:
        InputStream.skip(long)