- java.lang.Object
-
- java.io.Writer
-
- java.io.OutputStreamWriter
-
- All Implemented Interfaces:
- Closeable, Flushable, Appendable, AutoCloseable
- Direct Known Subclasses:
- FileWriter
public class OutputStreamWriter extends Writer
An OutputStreamWriter is a bridge from character streams to byte streams: Characters written to it are encoded into bytes using a specified
. The charset that it uses may be specified by name or may be given explicitly, or the platform's default charset may be accepted.charset
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 CharsetEncoder class should be used when more control over the encoding process is required.
- Since:
- JDK1.1
- See Also:
BufferedWriter
,OutputStream
,Charset
-
-
Field Summary
-
Fields inherited from class java.io.Writer
lock
-
-
Constructor Summary
Constructors Constructor and Description OutputStreamWriter(OutputStream out)
Creates an OutputStreamWriter that uses the default character encoding.OutputStreamWriter(OutputStream out, Charset cs)
Creates an OutputStreamWriter that uses the given charset.OutputStreamWriter(OutputStream out, CharsetEncoder enc)
Creates an OutputStreamWriter that uses the given charset encoder.OutputStreamWriter(OutputStream out, String charsetName)
Creates an OutputStreamWriter that uses the named charset.
-
Method Summary
Methods Modifier and Type Method and Description void
close()
Closes the stream, flushing it first.void
flush()
Flushes the stream.String
getEncoding()
Returns the name of the character encoding being used by this stream.void
write(char[] cbuf, int off, int len)
Writes a portion of an array of characters.void
write(int c)
Writes a single character.void
write(String str, int off, int len)
Writes a portion of a string.
-
-
-
Constructor Detail
-
OutputStreamWriter
public OutputStreamWriter(OutputStream out, String charsetName) throws UnsupportedEncodingException
Creates an OutputStreamWriter that uses the named charset.- Parameters:
out
- An OutputStreamcharsetName
- The name of a supportedcharset
- Throws:
UnsupportedEncodingException
- If the named encoding is not supported
-
OutputStreamWriter
public OutputStreamWriter(OutputStream out)
Creates an OutputStreamWriter that uses the default character encoding.- Parameters:
out
- An OutputStream
-
OutputStreamWriter
public OutputStreamWriter(OutputStream out, Charset cs)
Creates an OutputStreamWriter that uses the given charset.- Parameters:
out
- An OutputStreamcs
- A charset- Since:
- 1.4
-
OutputStreamWriter
public OutputStreamWriter(OutputStream out, CharsetEncoder enc)
Creates an OutputStreamWriter that uses the given charset encoder.- Parameters:
out
- An OutputStreamenc
- A charset encoder- Since:
- 1.4
-
-
Method Detail
-
getEncoding
public String getEncoding()
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(OutputStream, 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:
Charset
-
write
public void write(int c) throws IOException
Writes a single character.- Overrides:
write
in classWriter
- Parameters:
c
- int specifying a character to be written- Throws:
IOException
- If an I/O error occurs
-
write
public void write(char[] cbuf, int off, int len) throws IOException
Writes a portion of an array of characters.- Specified by:
write
in classWriter
- Parameters:
cbuf
- Buffer of charactersoff
- Offset from which to start writing characterslen
- Number of characters to write- Throws:
IOException
- If an I/O error occurs
-
write
public void write(String str, int off, int len) throws IOException
Writes a portion of a string.- Overrides:
write
in classWriter
- Parameters:
str
- A Stringoff
- Offset from which to start writing characterslen
- Number of characters to write- Throws:
IOException
- If an I/O error occurs
-
flush
public void flush() throws IOException
Flushes the stream.- Specified by:
flush
in interfaceFlushable
- Specified by:
flush
in classWriter
- Throws:
IOException
- If an I/O error occurs
-
close
public void close() throws IOException
Description copied from class:Writer
Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream has no effect.- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in classWriter
- Throws:
IOException
- If an I/O error occurs
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/io/outputstreamwriter.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.