KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > rtf > document > output > RtfDataCache


1 /*
2  * $Id: RtfDataCache.java 2776 2007-05-23 20:01:40Z hallm $
3  * $Name$
4  *
5  * Copyright 2005 by Mark Hall
6  *
7  * The contents of this file are subject to the Mozilla Public License Version 1.1
8  * (the "License"); you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the License.
14  *
15  * The Original Code is 'iText, a free JAVA-PDF library'.
16  *
17  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
18  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
19  * All Rights Reserved.
20  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
21  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
22  *
23  * Contributor(s): all the names of the contributors are added in the source code
24  * where applicable.
25  *
26  * Alternatively, the contents of this file may be used under the terms of the
27  * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the
28  * provisions of LGPL are applicable instead of those above. If you wish to
29  * allow use of your version of this file only under the terms of the LGPL
30  * License and not to allow others to use your version of this file under
31  * the MPL, indicate your decision by deleting the provisions above and
32  * replace them with the notice and other provisions required by the LGPL.
33  * If you do not delete the provisions above, a recipient may use your version
34  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Library General Public License as published by the Free Software Foundation;
39  * either version 2 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
43  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
44  * details.
45  *
46  * If you didn't download this code from the following link, you should check if
47  * you aren't using an obsolete version:
48  * http://www.lowagie.com/iText/
49  */
50
51 package com.lowagie.text.rtf.document.output;
52
53 import java.io.IOException JavaDoc;
54 import java.io.OutputStream JavaDoc;
55
56
57 /**
58  * The RtfDataCache interface must be implemented by classes wishing to
59  * act as caches for the rtf document data.
60  *
61  * @version $Id: RtfDataCache.java 2776 2007-05-23 20:01:40Z hallm $
62  * @author Mark Hall (mhall@edu.uni-klu.ac.at)
63  * @author Thomas Bickel (tmb99@inode.at)
64  */
65 public interface RtfDataCache
66 {
67     /**
68      * Constant for caching efficently into memory.
69      */
70     public static final int CACHE_MEMORY_EFFICIENT = 3;
71     /**
72      * Constant for caching into memory.
73      */
74     public static final int CACHE_MEMORY = 2;
75     /**
76      * Constant for caching to the disk.
77      */
78     public static final int CACHE_DISK = 1;
79     
80     /**
81      * Get the OutputStream that the RtfDocument can write to.
82      *
83      * @return The OutputStream the RtfDocument can use.
84      */
85     public OutputStream JavaDoc getOutputStream();
86     
87     /**
88      * Write the content of the cache into the OutputStream.
89      *
90      * @param target The OutputStream to write the content into.
91      * @throws IOException If an error occurs reading/writing.
92      */
93     public void writeTo(OutputStream JavaDoc target) throws IOException JavaDoc;
94 }
95
Popular Tags