forked from codehaus-plexus/plexus-utils
/
ReaderFactory.java
224 lines (205 loc) · 7.27 KB
/
ReaderFactory.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
package org.codehaus.plexus.util;
/*
* Copyright The Codehaus Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.net.URL;
import java.nio.charset.Charset;
import java.nio.file.Files;
import org.codehaus.plexus.util.xml.XmlStreamReader;
/**
* Utility to create Readers from streams, with explicit encoding choice: platform default, XML, or specified.
*
* @author <a href="mailto:hboutemy@codehaus.org">Herve Boutemy</a>
* @see Charset
* @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Supported encodings</a>
*
* @since 1.4.3
*/
public class ReaderFactory
{
/**
* ISO Latin Alphabet #1, also known as ISO-LATIN-1. Every implementation of the Java platform is required to
* support this character encoding.
*
* @see Charset
*/
public static final String ISO_8859_1 = "ISO-8859-1";
/**
* 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 Charset
*/
public static final String US_ASCII = "US-ASCII";
/**
* 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 Charset
*/
public static final String UTF_16 = "UTF-16";
/**
* Sixteen-bit Unicode Transformation Format, big-endian byte order. Every implementation of the Java platform is
* required to support this character encoding.
*
* @see Charset
*/
public static final String UTF_16BE = "UTF-16BE";
/**
* Sixteen-bit Unicode Transformation Format, little-endian byte order. Every implementation of the Java platform is
* required to support this character encoding.
*
* @see Charset
*/
public static final String UTF_16LE = "UTF-16LE";
/**
* Eight-bit Unicode Transformation Format. Every implementation of the Java platform is required to support this
* character encoding.
*
* @see Charset
*/
public static final String UTF_8 = "UTF-8";
/**
* The <code>file.encoding</code> System Property.
*/
public static final String FILE_ENCODING = System.getProperty( "file.encoding" );
/**
* Create a new Reader with XML encoding detection rules.
*
* @param in not null input stream.
* @return an XML reader instance for the input stream.
* @throws IOException if any.
* @see XmlStreamReader
*/
public static XmlStreamReader newXmlReader( InputStream in )
throws IOException
{
return new XmlStreamReader( in );
}
/**
* Create a new Reader with XML encoding detection rules.
*
* @param file not null file.
* @return an XML reader instance for the input file.
* @throws IOException if any.
* @see XmlStreamReader
*/
public static XmlStreamReader newXmlReader( File file )
throws IOException
{
return new XmlStreamReader( file );
}
/**
* Create a new Reader with XML encoding detection rules.
*
* @param url not null url.
* @return an XML reader instance for the input url.
* @throws IOException if any.
* @see XmlStreamReader
*/
public static XmlStreamReader newXmlReader( URL url )
throws IOException
{
return new XmlStreamReader( url );
}
/**
* Create a new Reader with default platform encoding.
*
* @param in not null input stream.
* @return a reader instance for the input stream using the default platform charset.
* @see Charset#defaultCharset()
*/
public static Reader newPlatformReader( InputStream in )
{
return new InputStreamReader( in );
}
/**
* Create a new Reader with default platform encoding.
*
* @param file not null file.
* @return a reader instance for the input file using the default platform charset.
* @throws IOException if any.
* @see Charset#defaultCharset()
*/
public static Reader newPlatformReader( File file )
throws IOException
{
return Files.newBufferedReader( file.toPath() );
}
/**
* Create a new Reader with default platform encoding.
*
* @param url not null url.
* @return a reader instance for the input url using the default platform charset.
* @throws IOException if any.
* @see Charset#defaultCharset()
*/
public static Reader newPlatformReader( URL url )
throws IOException
{
return new InputStreamReader( url.openStream() );
}
/**
* Create a new Reader with specified encoding.
*
* @param in not null input stream.
* @param encoding not null supported encoding.
* @return a reader instance for the input stream using the given encoding.
* @throws UnsupportedEncodingException if any.
* @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Supported encodings</a>
*/
public static Reader newReader( InputStream in, String encoding )
throws UnsupportedEncodingException
{
return new InputStreamReader( in, encoding );
}
/**
* Create a new Reader with specified encoding. Note that there is no buffering on this reader, which favours
* clients that read into large buffers (8K+).
*
* @param file not null file.
* @param encoding not null supported encoding.
* @return a reader instance for the input file using the given encoding.
* @throws IOException if any.
* @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Supported encodings</a>
*/
public static Reader newReader( File file, String encoding )
throws IOException
{
return new InputStreamReader( Files.newInputStream( file.toPath() ), encoding );
}
/**
* Create a new Reader with specified encoding.
*
* @param url not null url.
* @param encoding not null supported encoding.
* @return a reader instance for the input url using the given encoding.
* @throws IOException if any.
* @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Supported encodings</a>
*/
public static Reader newReader( URL url, String encoding )
throws IOException
{
return new InputStreamReader( url.openStream(), encoding );
}
}