Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
1
  /*
2
   * Copyright (c) 1996, 2006, Oracle and/or its affiliates. All rights reserved.
3
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4
   *
5
   * This code is free software; you can redistribute it and/or modify it
6
   * under the terms of the GNU General Public License version 2 only, as
7
   * published by the Free Software Foundation.  Oracle designates this
8
   * particular file as subject to the "Classpath" exception as provided
9
   * by Oracle in the LICENSE file that accompanied this code.
10
  *
11
  * This code is distributed in the hope that it will be useful, but WITHOUT
12
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14
  * version 2 for more details (a copy is included in the LICENSE file that
15
  * accompanied this code).
16
  *
17
  * You should have received a copy of the GNU General Public License version
18
  * 2 along with this work; if not, write to the Free Software Foundation,
19
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20
  *
21
  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22
  * or visit www.oracle.com if you need additional information or have any
23
  * questions.
24
  */
25
 
26
 package java.io;
27
 
An OutputStreamWriter is a bridge from character streams to byte streams: Characters written to it are encoded into bytes using a specified java.nio.charset.Charset. The charset that it uses may be specified by name or may be given explicitly, or the platform's default charset may be accepted.

Each invocation of a write() method causes the encoding converter to be invoked on the given character(s). The resulting bytes are accumulated in a buffer before being written to the underlying output stream. The size of this buffer may be specified, but by default it is large enough for most purposes. Note that the characters passed to the write() methods are not buffered.

For top efficiency, consider wrapping an OutputStreamWriter within a BufferedWriter so as to avoid frequent converter invocations. For example: 

 Writer out
   = new BufferedWriter(new OutputStreamWriter(System.out));

A surrogate pair is a character represented by a sequence of two char values: A high surrogate in the range '\uD800' to '\uDBFF' followed by a low surrogate in the range '\uDC00' to '\uDFFF'.

A malformed surrogate element is a high surrogate that is not followed by a low surrogate or a low surrogate that is not preceded by a high surrogate.

This class always replaces malformed surrogate elements and unmappable character sequences with the charset's default substitution sequence. The java.nio.charset.CharsetEncoder class should be used when more control over the encoding process is required.

Author(s):
Mark Reinhold
Since:
JDK1.1
See also:
BufferedWriter
OutputStream
java.nio.charset.Charset
75
 
76
 
77
 public class OutputStreamWriter extends Writer {
78
 
79
     private final StreamEncoder se;

    
Creates an OutputStreamWriter that uses the named charset.

Parameters:
out An OutputStream
charsetName The name of a supported charset
Throws:
UnsupportedEncodingException If the named encoding is not supported
93
 
94
     public OutputStreamWriter(OutputStream out, String charsetName)
95
         throws UnsupportedEncodingException
96
     {
97
         super(out);
98
         if (charsetName == null)
99
             throw new NullPointerException("charsetName");
100
         = StreamEncoder.forOutputStreamWriter(out, this, charsetName);
101
    }

    
Creates an OutputStreamWriter that uses the default character encoding.

Parameters:
out An OutputStream
108
    public OutputStreamWriter(OutputStream out) {
109
        super(out);
110
        try {
111
             = StreamEncoder.forOutputStreamWriter(out, this, (String)null);
112
        } catch (UnsupportedEncodingException e) {
113
            throw new Error(e);
114
        }
115
    }

    
Creates an OutputStreamWriter that uses the given charset.

Parameters:
out An OutputStream
cs A charset
Since:
1.4
Spec:
JSR-51
129
    public OutputStreamWriter(OutputStream out, Charset cs) {
130
        super(out);
131
        if (cs == null)
132
            throw new NullPointerException("charset");
133
         = StreamEncoder.forOutputStreamWriter(out, this, cs);
134
    }

    
Creates an OutputStreamWriter that uses the given charset encoder.

Parameters:
out An OutputStream
enc A charset encoder
Since:
1.4
Spec:
JSR-51
148
    public OutputStreamWriter(OutputStream out, CharsetEncoder enc) {
149
        super(out);
150
        if (enc == null)
151
            throw new NullPointerException("charset encoder");
152
         = StreamEncoder.forOutputStreamWriter(out, this, enc);
153
    }

    
Returns the name of the character encoding being used by this stream.

If the encoding has an historical name then that name is returned; otherwise the encoding's canonical name is returned.

If this instance was created with the OutputStreamWriter(java.io.OutputStream,java.lang.String) constructor then the returned name, being unique for the encoding, may differ from the name passed to the constructor. This method may return null if the stream has been closed.

Returns:
The historical name of this encoding, or possibly null if the stream has been closed
See also:
java.nio.charset.Charset
Revised:
1.4
Spec:
JSR-51
175
    public String getEncoding() {
176
        return .getEncoding();
177
    }

    
Flushes the output buffer to the underlying byte stream, without flushing the byte stream itself. This method is non-private only so that it may be invoked by PrintStream. 
184
    void flushBuffer() throws IOException {
185
        .flushBuffer();
186
    }

    
Writes a single character.

Throws:
IOException If an I/O error occurs
193
    public void write(int c) throws IOException {
194
        .write(c);
195
    }

    
Writes a portion of an array of characters.

Parameters:
cbuf Buffer of characters
off Offset from which to start writing characters
len Number of characters to write
Throws:
IOException If an I/O error occurs
206
    public void write(char cbuf[], int off, int len) throws IOException {
207
        .write(cbuf, off, len);
208
    }

    
Writes a portion of a string.

Parameters:
str A String
off Offset from which to start writing characters
len Number of characters to write
Throws:
IOException If an I/O error occurs
219
    public void write(String str, int off, int len) throws IOException {
220
        .write(str, off, len);
221
    }

    
Flushes the stream.

Throws:
IOException If an I/O error occurs
228
    public void flush() throws IOException {
229
        .flush();
230
    }
232
    public void close() throws IOException {
233
        .close();
234
    }
New to GrepCode? Check out our FAQ X