Java Doc for CharArrayWriter.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.Writer
      java.io.CharArrayWriter

CharArrayWriter
public class CharArrayWriter extends Writer (Code)
This class implements a character buffer that can be used as an Writer. The buffer automatically grows when data is written to the stream. The data can be retrieved using toCharArray() and toString().

Note: Invoking close() on this class has no effect, and methods of this class can be called after the stream has closed without generating an IOException.
author:
   Herb Jellinek
version:
   1.31, 05/05/07
since:
   JDK1.1



Field Summary
protected  charbuf
     The buffer where data is stored.
protected  intcount
     The number of chars in the buffer.

Constructor Summary
public  CharArrayWriter()
     Creates a new CharArrayWriter.
public  CharArrayWriter(int initialSize)
     Creates a new CharArrayWriter with the specified initial size.

Method Summary
public  CharArrayWriterappend(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.

public  CharArrayWriterappend(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()) 

Parameters:
  csq - The character sequence from which a subsequence will beappended.
public  CharArrayWriterappend(char c)
     Appends the specified character to this writer.
public  voidclose()
     Close the stream.
public  voidflush()
     Flush the stream.
public  voidreset()
     Resets the buffer so that you can use it again without throwing away the already allocated buffer.
public  intsize()
     Returns the current size of the buffer.
public  chartoCharArray()
     Returns a copy of the input data.
public  StringtoString()
     Converts input data to a string.
public  voidwrite(int c)
     Writes a character to the buffer.
public  voidwrite(char c, int off, int len)
     Writes characters to the buffer.
public  voidwrite(String str, int off, int len)
     Write a portion of a string to the buffer.
public  voidwriteTo(Writer out)
     Writes the contents of the buffer to another character stream.

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



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




Constructor Detail
CharArrayWriter
public CharArrayWriter()(Code)
Creates a new CharArrayWriter.



CharArrayWriter
public CharArrayWriter(int initialSize)(Code)
Creates a new CharArrayWriter with the specified initial size.
Parameters:
  initialSize - an int specifying the initial buffer size.
exception:
  IllegalArgumentException - if initialSize is negative




Method Detail
append
public CharArrayWriter append(CharSequence csq)(Code)
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.
Parameters:
  csq - The character sequence to append. If csq isnull, then the four characters "null" areappended to this writer. This writer
since:
   1.5




append
public CharArrayWriter append(CharSequence csq, int start, int end)(Code)
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()) 

Parameters:
  csq - The character sequence from which a subsequence will beappended. If csq is null, then characterswill be appended as if csq contained the fourcharacters "null".
Parameters:
  start - The index of the first character in the subsequence
Parameters:
  end - The index of the character following the last character in thesubsequence This writer
throws:
  IndexOutOfBoundsException - If start or end are negative, startis greater than end, or end is greater thancsq.length()
since:
   1.5



append
public CharArrayWriter append(char c)(Code)
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) 

Parameters:
  c - The 16-bit character to append This writer
since:
   1.5



close
public void close()(Code)
Close the stream. This method does not release the buffer, since its contents might still be required. Note: Invoking this method in this class will have no effect.



flush
public void flush()(Code)
Flush the stream.



reset
public void reset()(Code)
Resets the buffer so that you can use it again without throwing away the already allocated buffer.



size
public int size()(Code)
Returns the current size of the buffer. an int representing the current size of the buffer.



toCharArray
public char toCharArray()(Code)
Returns a copy of the input data. an array of chars copied from the input data.



toString
public String toString()(Code)
Converts input data to a string. the string.



write
public void write(int c)(Code)
Writes a character to the buffer.



write
public void write(char c, int off, int len)(Code)
Writes characters to the buffer.
Parameters:
  c - the data to be written
Parameters:
  off - the start offset in the data
Parameters:
  len - the number of chars that are written



write
public void write(String str, int off, int len)(Code)
Write a portion of a string to the buffer.
Parameters:
  str - String to be written from
Parameters:
  off - Offset from which to start reading characters
Parameters:
  len - Number of characters to be written



writeTo
public void writeTo(Writer out) throws IOException(Code)
Writes the contents of the buffer to another character stream.
Parameters:
  out - the output stream to write to
throws:
  IOException - If an I/O error occurs.



Fields inherited from java.io.Writer
protected Object lock(Code)(Java Doc)

Methods inherited from java.io.Writer
public Writer append(CharSequence csq) throws IOException(Code)(Java Doc)
public Writer append(CharSequence csq, int start, int end) throws IOException(Code)(Java Doc)
public Writer append(char c) throws IOException(Code)(Java Doc)
abstract public void close() throws IOException(Code)(Java Doc)
abstract public void flush() throws IOException(Code)(Java Doc)
public void write(int c) throws IOException(Code)(Java Doc)
public void write(char cbuf) throws IOException(Code)(Java Doc)
abstract public void write(char cbuf, int off, int len) throws IOException(Code)(Java Doc)
public void write(String str) throws IOException(Code)(Java Doc)
public void write(String str, 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.