1 /**
2 * Redistribution and use of this software and associated documentation
3 * ("Software"), with or without modification, are permitted provided
4 * that the following conditions are met:
5 *
6 * 1. Redistributions of source code must retain copyright
7 * statements and notices. Redistributions must also contain a
8 * copy of this document.
9 *
10 * 2. Redistributions in binary form must reproduce the
11 * above copyright notice, this list of conditions and the
12 * following disclaimer in the documentation and/or other
13 * materials provided with the distribution.
14 *
15 * 3. The name "Exolab" must not be used to endorse or promote
16 * products derived from this Software without prior written
17 * permission of Intalio, Inc. For written permission,
18 * please contact info@exolab.org.
19 *
20 * 4. Products derived from this Software may not be called "Exolab"
21 * nor may "Exolab" appear in their names without prior written
22 * permission of Intalio, Inc. Exolab is a registered
23 * trademark of Intalio, Inc.
24 *
25 * 5. Due credit should be given to the Exolab Project
26 * (http://www.exolab.org/).
27 *
28 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32 * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39 * OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Copyright 2002 (C) Intalio, Inc. All Rights Reserved.
42 *
43 * $Id$
44 */
45 package org.exolab.castor.net;
46
47
48 import java.io.*;
49
50 /**
51 * An interface for handling URIs
52 * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
53 * @version $Revision$ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $
54 **/
55 public abstract class URILocation {
56
57
58 /**
59 * Returns the absolute URI for this URILocation
60 *
61 * @return the absolute URI for this URILocation
62 * @see #getRelativeURI
63 * @see #getBaseURI
64 **/
65 public abstract String getAbsoluteURI();
66
67 /**
68 * Returns the base location of this URILocation.
69 * If this URILocation is an URL, the base location
70 * will be equivalent to the document base for the URL.
71 *
72 * @return the base location of this URILocation
73 * @see #getAbsoluteURI
74 * @see #getRelativeURI
75 **/
76 public abstract String getBaseURI();
77
78 /**
79 * Returns a Reader for the resource represented
80 * by this URILocation.
81 *
82 * @return a Reader for the resource represented by
83 * this URILocation
84 * @exception java.io.IOException
85 **/
86 public abstract Reader getReader()
87 throws java.io.IOException;
88
89 /**
90 * Returns the relative URI for this URILocation
91 *
92 * @return the relative URI for this URILocation
93 * @see #getAbsoluteURI
94 * @see #getBaseURI
95 **/
96 public abstract String getRelativeURI();
97
98 /**
99 * Returns the String representation of
100 * this URILocation.
101 *
102 * @return the String representation of this URILocation
103 **/
104 public String toString() {
105 return getAbsoluteURI();
106 }
107
108 } //-- URILocation