1 /**
2 * Copyright (C) 2005-2009 Alfresco Software Limited.
3 *
4 * This file is part of the Spring Surf Extension project.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 package org.springframework.extensions.surf.resource;
20
21 import java.io.IOException;
22 import java.io.InputStream;
23 import java.io.Reader;
24
25 /**
26 * Interface to describe content around a Resource.
27 *
28 * @author muzquiano
29 */
30 public interface ResourceContent
31 {
32 /**
33 * A link back to the resource of which this content is a part
34 *
35 * @return
36 */
37 public Resource getResource();
38
39 /**
40 * Returns the timestamp when this content convenience instance
41 * was created
42 *
43 * @return
44 */
45 public long getTimestamp();
46
47 /**
48 * Gets the bytes.
49 *
50 * @return the bytes
51 */
52 public byte[] getBytes() throws IOException;
53
54 /**
55 * Retrieves an input stream to the resource content
56 *
57 * @return the input stream
58 *
59 * @throws IOException Signals that an I/O exception has occurred.
60 */
61 public InputStream getInputStream() throws IOException;
62
63 /**
64 * Gets the reader for the resource content
65 *
66 * @return the reader
67 *
68 * @throws IOException Signals that an I/O exception has occurred.
69 */
70 public Reader getReader() throws IOException;
71
72 }