KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > avalon > excalibur > monitor > StreamResource


1 /*
2
3  ============================================================================
4                    The Apache Software License, Version 1.1
5  ============================================================================
6  
7  Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  
9  Redistribution and use in source and binary forms, with or without modifica-
10  tion, are permitted provided that the following conditions are met:
11  
12  1. Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14  
15  2. Redistributions in binary form must reproduce the above copyright notice,
16     this list of conditions and the following disclaimer in the documentation
17     and/or other materials provided with the distribution.
18  
19  3. The end-user documentation included with the redistribution, if any, must
20     include the following acknowledgment: "This product includes software
21     developed by the Apache Software Foundation (http://www.apache.org/)."
22     Alternately, this acknowledgment may appear in the software itself, if
23     and wherever such third-party acknowledgments normally appear.
24  
25  4. The names "Jakarta", "Avalon", "Excalibur" and "Apache Software Foundation"
26     must not be used to endorse or promote products derived from this software
27     without prior written permission. For written permission, please contact
28     apache@apache.org.
29  
30  5. Products derived from this software may not be called "Apache", nor may
31     "Apache" appear in their name, without prior written permission of the
32     Apache Software Foundation.
33  
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  
45  This software consists of voluntary contributions made by many individuals
46  on behalf of the Apache Software Foundation. For more information on the
47  Apache Software Foundation, please see <http://www.apache.org/>.
48  
49 */
50 package org.apache.avalon.excalibur.monitor;
51
52 import java.io.IOException JavaDoc;
53 import java.io.InputStream JavaDoc;
54 import java.io.OutputStream JavaDoc;
55 import java.io.Reader JavaDoc;
56 import java.io.Writer JavaDoc;
57
58 /**
59  * Managed Stream based Resource. This is convenient when you want to dynamically
60  * set and get the information from the resource. For instance, the Resource does
61  * not need to be actively monitored if all access to the resource goes through
62  * this type of Resource. It can notify the change as soon as the Writer or
63  * OutputStream has been closed.
64  *
65  * @author <a HREF="mailto:bloritsch@apache.org">Berin Loritsch</a>
66  * @version $Id: StreamResource.java,v 1.10 2003/03/22 12:46:50 leosimons Exp $
67  */
68 public abstract class StreamResource
69     extends Resource
70 {
71     /**
72      * Required constructor. The <code>String</code> location is transformed by
73      * the specific resource monitor. For instance, a FileResource will be able
74      * to convert a string representation of a path to the proper File object.
75      */
76     public StreamResource( final String JavaDoc location )
77         throws Exception JavaDoc
78     {
79         super( location );
80     }
81
82     /**
83      * Get the Resource contents as an InputStream.
84      */
85     public abstract InputStream JavaDoc getResourceAsStream()
86         throws IOException JavaDoc;
87
88     /**
89      * Get the Resource contents as a Reader.
90      */
91     public abstract Reader JavaDoc getResourceAsReader()
92         throws IOException JavaDoc;
93
94     /**
95      * Set the Resource contents as an OutputStream.
96      */
97     public abstract OutputStream JavaDoc setResourceAsStream()
98         throws IOException JavaDoc;
99
100     /**
101      * Set the Resource contents as a Writer.
102      */
103     public abstract Writer JavaDoc setResourceAsWriter() throws IOException JavaDoc;
104
105     /**
106      * Automatically handle the streamClosedEvent from the ResourceOutputStream
107      * and ResourceWriter.
108      */
109     protected void streamClosedEvent()
110     {
111         fireAndSetModifiedTime( System.currentTimeMillis() );
112     }
113 }
114
Popular Tags