001: /**
002: * Redistribution and use of this software and associated documentation
003: * ("Software"), with or without modification, are permitted provided
004: * that the following conditions are met:
005: *
006: * 1. Redistributions of source code must retain copyright
007: * statements and notices. Redistributions must also contain a
008: * copy of this document.
009: *
010: * 2. Redistributions in binary form must reproduce the
011: * above copyright notice, this list of conditions and the
012: * following disclaimer in the documentation and/or other
013: * materials provided with the distribution.
014: *
015: * 3. The name "Exolab" must not be used to endorse or promote
016: * products derived from this Software without prior written
017: * permission of Intalio, Inc. For written permission,
018: * please contact info@exolab.org.
019: *
020: * 4. Products derived from this Software may not be called "Exolab"
021: * nor may "Exolab" appear in their names without prior written
022: * permission of Intalio, Inc. Exolab is a registered
023: * trademark of Intalio, Inc.
024: *
025: * 5. Due credit should be given to the Exolab Project
026: * (http://www.exolab.org/).
027: *
028: * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS
029: * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
030: * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
031: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
032: * INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
033: * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
034: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
035: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
036: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
037: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
038: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
039: * OF THE POSSIBILITY OF SUCH DAMAGE.
040: *
041: * Copyright 2002 (C) Intalio, Inc. All Rights Reserved.
042: *
043: * $Id: URILocation.java 5951 2006-05-30 22:18:48Z bsnyder $
044: */package org.exolab.castor.net;
045:
046: import java.io.*;
047:
048: /**
049: * An interface for handling URIs
050: * @author <a href="mailto:kvisco@intalio.com">Keith Visco</a>
051: * @version $Revision: 5951 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $
052: **/
053: public abstract class URILocation {
054:
055: /**
056: * Returns the absolute URI for this URILocation
057: *
058: * @return the absolute URI for this URILocation
059: * @see #getRelativeURI
060: * @see #getBaseURI
061: **/
062: public abstract String getAbsoluteURI();
063:
064: /**
065: * Returns the base location of this URILocation.
066: * If this URILocation is an URL, the base location
067: * will be equivalent to the document base for the URL.
068: *
069: * @return the base location of this URILocation
070: * @see #getAbsoluteURI
071: * @see #getRelativeURI
072: **/
073: public abstract String getBaseURI();
074:
075: /**
076: * Returns a Reader for the resource represented
077: * by this URILocation.
078: *
079: * @return a Reader for the resource represented by
080: * this URILocation
081: * @exception java.io.IOException
082: **/
083: public abstract Reader getReader() throws java.io.IOException;
084:
085: /**
086: * Returns the relative URI for this URILocation
087: *
088: * @return the relative URI for this URILocation
089: * @see #getAbsoluteURI
090: * @see #getBaseURI
091: **/
092: public abstract String getRelativeURI();
093:
094: /**
095: * Returns the String representation of
096: * this URILocation.
097: *
098: * @return the String representation of this URILocation
099: **/
100: public String toString() {
101: return getAbsoluteURI();
102: }
103:
104: } //-- URILocation
|