KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > util > swing > DocumentOutputStream


1 /*BEGIN_COPYRIGHT_BLOCK
2  *
3  * This file is part of DrJava. Download the current version of this project from http://www.drjava.org/
4  * or http://sourceforge.net/projects/drjava/
5  *
6  * DrJava Open Source License
7  *
8  * Copyright (C) 2001-2005 JavaPLT group at Rice University (javaplt@rice.edu). All rights reserved.
9  *
10  * Developed by: Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
13  * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
15  * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16  *
17  * - Redistributions of source code must retain the above copyright notice, this list of conditions and the
18  * following disclaimers.
19  * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
20  * following disclaimers in the documentation and/or other materials provided with the distribution.
21  * - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to
22  * endorse or promote products derived from this Software without specific prior written permission.
23  * - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their
24  * names without prior written permission from the JavaPLT group. For permission, write to javaplt@rice.edu.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
27  * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28  * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
29  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
30  * WITH THE SOFTWARE.
31  *
32  *END_COPYRIGHT_BLOCK*/

33
34 package edu.rice.cs.util.swing;
35
36 import java.io.OutputStream JavaDoc;
37 import javax.swing.text.Document JavaDoc;
38 import javax.swing.text.BadLocationException JavaDoc;
39 import javax.swing.text.AttributeSet JavaDoc;
40
41 /**
42  * An extension of {@link OutputStream} that writes its output to
43  * an implementation of {@link Document}.
44  *
45  * @version $Id: DocumentOutputStream.java 3553 2006-02-20 21:22:09Z rcartwright $
46  */

47 public class DocumentOutputStream extends OutputStream JavaDoc {
48   private Document JavaDoc _doc;
49   private AttributeSet JavaDoc _attributes;
50
51   /**
52    * Constructs an {@link OutputStream} that writes its output to a
53    * {@link Document}.
54    *
55    * When this constructor is used, all insertions to the Document will
56    * be done with the attributes set to <code>null</code>.
57    *
58    * @param doc Document to write output to.
59    */

60   public DocumentOutputStream(Document JavaDoc doc) {
61     this(doc, null);
62   }
63
64   /**
65    * Constructs an {@link OutputStream} that writes its output to a
66    * {@link Document}.
67    *
68    * @param doc Document to write output to.
69    * @param attributes Attributes to use for inserting text into the document
70    * that is sent to this stream.
71    */

72   public DocumentOutputStream(Document JavaDoc doc, AttributeSet JavaDoc attributes) {
73     _doc = doc;
74     _attributes = attributes;
75   }
76
77   /**
78    * Write a character to the stream.
79    * @param c the ASCII value of the character to write.
80    */

81   public void write(int c) {
82     try {
83       _doc.insertString(_doc.getLength(), String.valueOf((char)c), _attributes);
84     } catch (BadLocationException JavaDoc canNeverHappen) {
85       throw new RuntimeException JavaDoc("Internal error: bad location in OutputWindowStream");
86     }
87   }
88
89   /**
90    * Write an array of characters (bytes) to the stream at a particular offset.
91    * @param b characters to write to stream
92    * @param off start of writing
93    * @param len number of characters to write from b
94    */

95   public void write(byte[] b, int off, int len) {
96     try {
97       _doc.insertString(_doc.getLength(), new String JavaDoc(b, off, len), _attributes);
98     } catch (BadLocationException JavaDoc canNevenHappen) {
99       throw new RuntimeException JavaDoc("Internal error: bad location in OutputWindowStream");
100     }
101   }
102 }
103
Popular Tags