- java.lang.Object
-
- java.io.OutputStream
-
- java.io.ByteArrayOutputStream
-
- All Implemented Interfaces:
- Closeable, Flushable, AutoCloseable
public class ByteArrayOutputStream extends OutputStream
This class implements an output stream in which the data is written into a byte array. The buffer automatically grows as data is written to it. The data can be retrieved usingtoByteArray()
andtoString()
.Closing a ByteArrayOutputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.
- Since:
- JDK1.0
-
-
Field Summary
Fields Modifier and Type Field and Description protected byte[]
buf
The buffer where data is stored.protected int
count
The number of valid bytes in the buffer.
-
Constructor Summary
Constructors Constructor and Description ByteArrayOutputStream()
Creates a new byte array output stream.ByteArrayOutputStream(int size)
Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.
-
Method Summary
Methods Modifier and Type Method and Description void
close()
Closing a ByteArrayOutputStream has no effect.void
reset()
Resets thecount
field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded.int
size()
Returns the current size of the buffer.byte[]
toByteArray()
Creates a newly allocated byte array.String
toString()
Converts the buffer's contents into a string decoding bytes using the platform's default character set.String
toString(int hibyte)
Deprecated.This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via thetoString(String enc)
method, which takes an encoding-name argument, or thetoString()
method, which uses the platform's default character encoding.String
toString(String charsetName)
Converts the buffer's contents into a string by decoding the bytes using the specifiedcharsetName
.void
write(byte[] b, int off, int len)
Writeslen
bytes from the specified byte array starting at offsetoff
to this byte array output stream.void
write(int b)
Writes the specified byte to this byte array output stream.void
writeTo(OutputStream out)
Writes the complete contents of this byte array output stream to the specified output stream argument, as if by calling the output stream's write method usingout.write(buf, 0, count)
.
-
-
-
Field Detail
-
buf
protected byte[] buf
The buffer where data is stored.
-
count
protected int count
The number of valid bytes in the buffer.
-
-
Constructor Detail
-
ByteArrayOutputStream
public ByteArrayOutputStream()
Creates a new byte array output stream. The buffer capacity is initially 32 bytes, though its size increases if necessary.
-
ByteArrayOutputStream
public ByteArrayOutputStream(int size)
Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.- Parameters:
size
- the initial size.- Throws:
IllegalArgumentException
- if size is negative.
-
-
Method Detail
-
write
public void write(int b)
Writes the specified byte to this byte array output stream.- Specified by:
write
in classOutputStream
- Parameters:
b
- the byte to be written.
-
write
public void write(byte[] b, int off, int len)
Writeslen
bytes from the specified byte array starting at offsetoff
to this byte array output stream.- Overrides:
write
in classOutputStream
- Parameters:
b
- the data.off
- the start offset in the data.len
- the number of bytes to write.
-
writeTo
public void writeTo(OutputStream out) throws IOException
Writes the complete contents of this byte array output stream to the specified output stream argument, as if by calling the output stream's write method usingout.write(buf, 0, count)
.- Parameters:
out
- the output stream to which to write the data.- Throws:
IOException
- if an I/O error occurs.
-
reset
public void reset()
Resets thecount
field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded. The output stream can be used again, reusing the already allocated buffer space.- See Also:
ByteArrayInputStream.count
-
toByteArray
public byte[] toByteArray()
Creates a newly allocated byte array. Its size is the current size of this output stream and the valid contents of the buffer have been copied into it.- Returns:
- the current contents of this output stream, as a byte array.
- See Also:
size()
-
size
public int size()
Returns the current size of the buffer.- Returns:
- the value of the
count
field, which is the number of valid bytes in this output stream. - See Also:
count
-
toString
public String toString()
Converts the buffer's contents into a string decoding bytes using the platform's default character set. The length of the new String is a function of the character set, and hence may not be equal to the size of the buffer.This method always replaces malformed-input and unmappable-character sequences with the default replacement string for the platform's default character set. The CharsetDecoder class should be used when more control over the decoding process is required.
-
toString
public String toString(String charsetName) throws UnsupportedEncodingException
Converts the buffer's contents into a string by decoding the bytes using the specifiedcharsetName
. The length of the new String is a function of the charset, and hence may not be equal to the length of the byte array.This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement string. The
CharsetDecoder
class should be used when more control over the decoding process is required.- Parameters:
charsetName
- the name of a supported charset- Returns:
- String decoded from the buffer's contents.
- Throws:
UnsupportedEncodingException
- If the named charset is not supported- Since:
- JDK1.1
-
toString
@Deprecated public String toString(int hibyte)
Deprecated. This method does not properly convert bytes into characters. As of JDK 1.1, the preferred way to do this is via thetoString(String enc)
method, which takes an encoding-name argument, or thetoString()
method, which uses the platform's default character encoding.Creates a newly allocated string. Its size is the current size of the output stream and the valid contents of the buffer have been copied into it. Each character c in the resulting string is constructed from the corresponding element b in the byte array such that:c == (char)(((hibyte & 0xff) << 8) | (b & 0xff))
- Parameters:
hibyte
- the high byte of each resulting Unicode character.- Returns:
- the current contents of the output stream, as a string.
- See Also:
size()
,toString(String)
,toString()
-
close
public void close() throws IOException
Closing a ByteArrayOutputStream 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
- Overrides:
close
in classOutputStream
- 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/11/2024 21:28:31 Cette version de la page est en cache (à la date du 21/11/2024 21:28:31) 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 31/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/io/bytearrayoutputstream.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.