- java.lang.Object
-
- java.io.Writer
-
- java.io.StringWriter
-
- All Implemented Interfaces:
- Closeable, Flushable, Appendable, AutoCloseable
public class StringWriter extends Writer
A character stream that collects its output in a string buffer, which can then be used to construct a string.Closing a StringWriter has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.
- Since:
- JDK1.1
-
-
Field Summary
-
Fields inherited from class java.io.Writer
lock
-
-
Constructor Summary
Constructors Constructor and Description StringWriter()
Create a new string writer using the default initial string-buffer size.StringWriter(int initialSize)
Create a new string writer using the specified initial string-buffer size.
-
Method Summary
Methods Modifier and Type Method and Description StringWriter
append(char c)
Appends the specified character to this writer.StringWriter
append(CharSequence csq)
Appends the specified character sequence to this writer.StringWriter
append(CharSequence csq, int start, int end)
Appends a subsequence of the specified character sequence to this writer.void
close()
Closing a StringWriter has no effect.void
flush()
Flush the stream.StringBuffer
getBuffer()
Return the string buffer itself.String
toString()
Return the buffer's current value as a string.void
write(char[] cbuf, int off, int len)
Write a portion of an array of characters.void
write(int c)
Write a single character.void
write(String str)
Write a string.void
write(String str, int off, int len)
Write a portion of a string.-
Methods inherited from class java.io.Writer
write
-
-
-
-
Constructor Detail
-
StringWriter
public StringWriter()
Create a new string writer using the default initial string-buffer size.
-
StringWriter
public StringWriter(int initialSize)
Create a new string writer using the specified initial string-buffer size.- Parameters:
initialSize
- The number of char values that will fit into this buffer before it is automatically expanded- Throws:
IllegalArgumentException
- If initialSize is negative
-
-
Method Detail
-
write
public void write(int c)
Write a single character.
-
write
public void write(char[] cbuf, int off, int len)
Write a portion of an array of characters.
-
write
public void write(String str)
Write a string.
-
write
public void write(String str, int off, int len)
Write a portion of a string.
-
append
public StringWriter append(CharSequence csq)
Appends the specified character sequence to this writer.An invocation of this method of the form out.append(csq) behaves in exactly the same way as the invocation
out.write(csq.toString())
Depending on the specification of toString for the character sequence csq, the entire sequence may not be appended. For instance, invoking the toString method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.
- Specified by:
append
in interfaceAppendable
- Overrides:
append
in classWriter
- Parameters:
csq
- The character sequence to append. If csq is null, then the four characters "null" are appended to this writer.- Returns:
- This writer
- Since:
- 1.5
-
append
public StringWriter append(CharSequence csq, int start, int end)
Appends a subsequence of the specified character sequence to this writer.An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation
out.write(csq.subSequence(start, end).toString())
- Specified by:
append
in interfaceAppendable
- Overrides:
append
in classWriter
- Parameters:
csq
- The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".start
- The index of the first character in the subsequenceend
- The index of the character following the last character in the subsequence- Returns:
- This writer
- Throws:
IndexOutOfBoundsException
- If start or end are negative, start is greater than end, or end is greater than csq.length()- Since:
- 1.5
-
append
public StringWriter append(char c)
Appends the specified character to this writer.An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation
out.write(c)
- Specified by:
append
in interfaceAppendable
- Overrides:
append
in classWriter
- Parameters:
c
- The 16-bit character to append- Returns:
- This writer
- Since:
- 1.5
-
toString
public String toString()
Return the buffer's current value as a string.
-
getBuffer
public StringBuffer getBuffer()
Return the string buffer itself.- Returns:
- StringBuffer holding the current buffer value.
-
flush
public void flush()
Flush the stream.
-
close
public void close() throws IOException
Closing a StringWriter has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in classWriter
- Throws:
IOException
- If an I/O error occurs
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/12/2024 02:02:19 Cette version de la page est en cache (à la date du 21/12/2024 02:02:19) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 29/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/io/StringWriter.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.