ContentSource


1   /*-- 
2   
3    Copyright (C) 2001-2003 Aetrion LLC.
4    All rights reserved.
5    
6    Redistribution and use in source and binary forms, with or without
7    modification, are permitted provided that the following conditions
8    are met:
9    
10   1. Redistributions of source code must retain the above copyright
11      notice, this list of conditions, and the following disclaimer.
12   
13   2. Redistributions in binary form must reproduce the above copyright
14      notice, this list of conditions, and the disclaimer that follows 
15      these conditions in the documentation and/or other materials 
16      provided with the distribution.
17  
18   3. The name "JPublish" must not be used to endorse or promote products
19      derived from this software without prior written permission.  For
20      written permission, please contact info@aetrion.com.
21   
22   4. Products derived from this software may not be called "JPublish", nor
23      may "JPublish" appear in their name, without prior written permission
24      from Aetrion LLC (info@aetrion.com).
25   
26   In addition, the authors of this software request (but do not require) 
27   that you include in the end-user documentation provided with the 
28   redistribution and/or in the software itself an acknowledgement equivalent 
29   to the following:
30       "This product includes software developed by
31        Aetrion LLC (http://www.aetrion.com/)."
32  
33   THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36   DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, 
37   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
38   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
39   SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
40   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
41   STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
42   IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
43   POSSIBILITY OF SUCH DAMAGE.
44  
45   For more information on JPublish, please see <http://www.jpublish.org/>.
46   
47   */
48  
49  package org.jpublish.view;
50  
51  import java.io.IOException  ;
52  import java.io.InputStream  ;
53  import java.io.Reader  ;
54  
55  /**
56   * Interface used by view renderer resource loaders to determine if a template needs to be parsed.
57   *
58   * @author Anthony Eden
59   */
60  
61  public interface ContentSource {
62  
63      /**
64       * Get the last modified time for the content defined by this content source.
65       *
66       * @return The last modified time
67       * @throws IOException
68       */
69  
70      public long getLastModified() throws IOException  ;
71  
72      /**
73       * Get an InputStream for reading the content data.
74       *
75       * @return The content InputStream
76       * @throws IOException
77       */
78  
79      public InputStream   getInputStream() throws IOException  ;
80  
81      /**
82       * Get a Reader for the content defined by this content source.
83       *
84       * @return A Reader
85       * @throws IOException
86       */
87  
88      public Reader   getReader() throws IOException  ;
89  
90      /**
91       * Get a Reader for the content defined by this content source.  The Reader will be constructed using the given
92       * character encoding.
93       *
94       * @param encoding The character encoding
95       * @return A Reader
96       * @throws IOException
97       */
98  
99      public Reader   getReader(String   encoding) throws IOException  ;
100 
101 }
102
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags