01: /*
02: * Copyright (C) 2004 TiongHiang Lee
03: *
04: * This library is free software; you can redistribute it and/or
05: * modify it under the terms of the GNU Lesser General Public
06: * License as published by the Free Software Foundation; either
07: * version 2.1 of the License, or (at your option) any later version.
08: *
09: * This library is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public
15: * License along with this library; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: *
18: * Email: thlee@onemindsoft.org
19: */
20:
21: package org.onemind.swingweb.resource;
22:
23: import java.io.IOException;
24: import java.io.InputStream;
25:
26: /**
27: * Interface for resource that can be retrieved
28: * using getInputStream.
29: *
30: * IMPORTANT: The subclass must override the hashCode()
31: * and equals() to indicate the underlying resource is the
32: * same so that the caching of the resource can be done appropriately.
33: *
34: * @author TiongHiang Lee (thlee@onemindsoft.org)
35: *
36: */
37: public interface Resource {
38: /**
39: * Return the type of resource
40: * @return the type
41: */
42: public String getType();
43:
44: /**
45: * Get a unique id identify this resource
46: * @return the id
47: */
48: public String getId();
49:
50: /**
51: * The resource object is the identifier of the physical resource
52: * @return the resource object
53: */
54: public Object getResourceObject();
55:
56: /**
57: * Get the url
58: * @return the url
59: */
60: public InputStream getInputStream() throws IOException;
61: }
|