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