01: /*
02: * Janino - An embedded Java[TM] compiler
03: *
04: * Copyright (c) 2006, Arno Unkrig
05: * All rights reserved.
06: *
07: * Redistribution and use in source and binary forms, with or without
08: * modification, are permitted provided that the following conditions
09: * are met:
10: *
11: * 1. Redistributions of source code must retain the above copyright
12: * notice, this list of conditions and the following disclaimer.
13: * 2. Redistributions in binary form must reproduce the above
14: * copyright notice, this list of conditions and the following
15: * disclaimer in the documentation and/or other materials
16: * provided with the distribution.
17: * 3. The name of the author may not be used to endorse or promote
18: * products derived from this software without specific prior
19: * written permission.
20: *
21: * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22: * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23: * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24: * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
25: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
29: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
31: * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32: */
33:
34: package org.codehaus.janino.util.resource;
35:
36: import java.io.*;
37:
38: /**
39: * A {@link Resource} is "something" that is typically found by a
40: * {@link org.codehaus.janino.util.resource.ResourceFinder}, can be {@link #open()}ed for
41: * reading, and optionally has a {@link #lastModified()} property.
42: * <p>
43: * There also exists a {@link org.codehaus.janino.util.resource.ResourceCreator} concept which
44: * opens a resource for writing, but that happens directly and not through an intermediate
45: * {@link Resource} object.
46: *
47: * @see org.codehaus.janino.util.resource.ResourceFinder
48: * @see org.codehaus.janino.util.resource.ResourceCreator
49: */
50: public interface Resource {
51:
52: /**
53: * Opens the resource. The caller is responsible for closing the
54: * {@link java.io.InputStream}.
55: */
56: InputStream open() throws IOException;
57:
58: /**
59: * Returns a decorative "file name" that can be used for reporting
60: * errors and the like. It does not necessarily map to a file in the
61: * local file system!
62: */
63: String getFileName();
64:
65: /**
66: * Returns the time of the last modification, in milliseconds since
67: * 1970, or <code>0L</code> if the time of the last modification cannot
68: * be determined.
69: */
70: long lastModified();
71: }
|