Java Doc for ByteArrayOutputStream.java in  » 6.0-JDK-Core » io-nio » java » io » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » io nio » java.io 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.OutputStream
      java.io.ByteArrayOutputStream

ByteArrayOutputStream
public class ByteArrayOutputStream extends OutputStream (Code)
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 using toByteArray() and toString().

Closing a ByteArrayOutputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.
author:
   Arthur van Hoff
version:
   1.59, 05/05/07
since:
   JDK1.0



Field Summary
protected  bytebuf
     The buffer where data is stored.
protected  intcount
     The number of valid bytes in the buffer.

Constructor Summary
public  ByteArrayOutputStream()
     Creates a new byte array output stream.
public  ByteArrayOutputStream(int size)
     Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.

Method Summary
public  voidclose()
     Closing a ByteArrayOutputStream has no effect.
public synchronized  voidreset()
     Resets the count field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded.
public synchronized  intsize()
     Returns the current size of the buffer.
public synchronized  bytetoByteArray()
     Creates a newly allocated byte array.
public synchronized  StringtoString()
     Converts the buffer's contents into a string decoding bytes using the platform's default character set.
public synchronized  StringtoString(String charsetName)
     Converts the buffer's contents into a string by decoding the bytes using the specified java.nio.charset.Charset charsetName .
public synchronized  StringtoString(int hibyte)
     Creates a newly allocated string.
public synchronized  voidwrite(int b)
     Writes the specified byte to this byte array output stream.
public synchronized  voidwrite(byte b, int off, int len)
     Writes len bytes from the specified byte array starting at offset off to this byte array output stream.
public synchronized  voidwriteTo(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 using out.write(buf, 0, count).

Field Detail
buf
protected byte buf(Code)
The buffer where data is stored.



count
protected int count(Code)
The number of valid bytes in the buffer.




Constructor Detail
ByteArrayOutputStream
public ByteArrayOutputStream()(Code)
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)(Code)
Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes.
Parameters:
  size - the initial size.
exception:
  IllegalArgumentException - if size is negative.




Method Detail
close
public void close() throws IOException(Code)
Closing a ByteArrayOutputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException.




reset
public synchronized void reset()(Code)
Resets the count 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:   java.io.ByteArrayInputStream.count



size
public synchronized int size()(Code)
Returns the current size of the buffer. the value of the count field, which is the numberof valid bytes in this output stream.
See Also:   java.io.ByteArrayOutputStream.count



toByteArray
public synchronized byte toByteArray()(Code)
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. the current contents of this output stream, as a byte array.
See Also:   java.io.ByteArrayOutputStream.size



toString
public synchronized String toString()(Code)
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 class should be used when more control over the decoding process is required. String decoded from the buffer's contents.
since:
   JDK1.1




toString
public synchronized String toString(String charsetName) throws UnsupportedEncodingException(Code)
Converts the buffer's contents into a string by decoding the bytes using the specified java.nio.charset.Charset charsetName . 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 java.nio.charset.CharsetDecoder class should be used when more control over the decoding process is required.
Parameters:
  charsetName - the name of a supported String decoded from the buffer's contents.
exception:
  UnsupportedEncodingException - If the named charset is not supported
since:
   JDK1.1




toString
public synchronized String toString(int hibyte)(Code)
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. the current contents of the output stream, as a string.
See Also:   java.io.ByteArrayOutputStream.size
See Also:   java.io.ByteArrayOutputStream.toString(String)
See Also:   java.io.ByteArrayOutputStream.toString



write
public synchronized void write(int b)(Code)
Writes the specified byte to this byte array output stream.
Parameters:
  b - the byte to be written.



write
public synchronized void write(byte b, int off, int len)(Code)
Writes len bytes from the specified byte array starting at offset off to this byte array output stream.
Parameters:
  b - the data.
Parameters:
  off - the start offset in the data.
Parameters:
  len - the number of bytes to write.



writeTo
public synchronized void writeTo(OutputStream out) throws IOException(Code)
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 using out.write(buf, 0, count).
Parameters:
  out - the output stream to which to write the data.
exception:
  IOException - if an I/O error occurs.



Methods inherited from java.io.OutputStream
public void close() throws IOException(Code)(Java Doc)
public void flush() throws IOException(Code)(Java Doc)
abstract public void write(int b) throws IOException(Code)(Java Doc)
public void write(byte b) throws IOException(Code)(Java Doc)
public void write(byte b, int off, int len) throws IOException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.