libjava/java/net/URI.java

   1 /* URI.java - An URI class
   2    Copyright (C) 2002 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package java.net;
  39
  40 import java.io.IOException;
  41 import java.io.ObjectInputStream;
  42 import java.io.ObjectOutputStream;
  43 import java.io.Serializable;
  44
  45 /**
  46  * @author Michael Koch <konqueror@gmx.de>
  47  * @since 1.4
  48  */
  49 public final class URI
  50   implements Comparable, Serializable
  51 {
  52   static final long serialVersionUID = -6052424284110960213L;
  53
  54   String string;
  55   private String scheme;
  56   private String schemeSpecificPart;
  57   private String authority;
  58   private String userInfo;
  59   private String host;
  60   private int port;
  61   private String path;
  62   private String query;
  63   private String fragment;
  64
  65   private void readObject (ObjectInputStream is)
  66     throws ClassNotFoundException, IOException
  67   {
  68   }
  69
  70   private void writeObject (ObjectOutputStream is)
  71     throws IOException
  72   {
  73   }
  74
  75   private void parseURI (String str)
  76     throws URISyntaxException
  77   {
  78   }
  79
  80   /**
  81    * Creates an URI from the given string
  82    *
  83    * @param str The string to create the URI from
  84    *
  85    * @exception URISyntaxException If the given string violates RFC 2396
  86    * @exception NullPointerException If str is null
  87    */
  88   public URI (String str)
  89     throws URISyntaxException
  90   {
  91   }
  92
  93   /**
  94    * Create an URI from the given components
  95    *
  96    * @param scheme The scheme name
  97    * @param userInfo The username and authorization info
  98    * @param host The hostname
  99    * @param port The port number
 100    * @param path The path
 101    * @param query The query
 102    * @param fragment The fragment
 103    *
 104    * @exception URISyntaxException If the given string violates RFC 2396
 105    */
 106   public URI (String scheme, String userInfo, String host, int port,
 107              String path, String query, String fragment)
 108     throws URISyntaxException
 109   {
 110   }
 111
 112   /**
 113    * Create an URI from the given components
 114    *
 115    * @param scheme The scheme name
 116    * @param authority The authority
 117    * @param path The apth
 118    * @param query The query
 119    * @param fragment The fragmen
 120    *
 121    * @exception URISyntaxException If the given string violates RFC 2396
 122    */
 123   public URI (String scheme, String authority, String path, String query,
 124              String fragment)
 125     throws URISyntaxException
 126   {
 127   }
 128
 129   /**
 130    * Create an URI from the given components
 131    *
 132    * @param scheme The scheme name
 133    * @param host The hostname
 134    * @param path The path
 135    * @param fragment The fragment
 136    *
 137    * @exception URISyntaxException If the given string violates RFC 2396
 138    */
 139   public URI (String scheme, String host, String path, String fragment)
 140     throws URISyntaxException
 141   {
 142   }
 143
 144   /**
 145    * Create an URI from the given components
 146    *
 147    * @param scheme The scheme name
 148    * @param ssp The scheme specific part
 149    * @param fragment The fragment
 150    *
 151    * @exception URISyntaxException If the given string violates RFC 2396
 152    */
 153   public URI (String scheme, String ssp, String fragment)
 154     throws URISyntaxException
 155   {
 156   }
 157
 158   /**
 159    * Create an URI from the given string
 160    *
 161    * @param str The string to create the URI from
 162    *
 163    * @exception IllegalArgumentException If the given string violates RFC 2396
 164    * @exception NullPointerException If str is null
 165    */
 166   public static URI create (String str)
 167   {
 168     return null;
 169   }
 170
 171   /**
 172    * Attempts to parse this URI's authority component, if defined,
 173    * into user-information, host, and port components
 174    *
 175    * @exception URISyntaxException If the given string violates RFC 2396
 176    */
 177   public URI parseServerAuthority ()
 178      throws URISyntaxException
 179   {
 180     return null;
 181   }
 182
 183   /**
 184    * Returns a normalizes versions of the URI
 185    */
 186   public URI normalize ()
 187   {
 188     return null;
 189   }
 190
 191   /**
 192    * Resolves the given URI against this URI
 193    *
 194    * @param uri The URI to resolve against this URI
 195    *
 196    * @return The resulting URI
 197    *
 198    * @exception NullPointerException If uri is null
 199    */
 200   public URI resolve (URI uri)
 201   {
 202     return null;
 203   }
 204
 205   /**
 206    * Resolves the given URI string against this URI
 207    *
 208    * @param str The URI as string to resolve against this URI
 209    *
 210    * @return The resulting URI
 211    *
 212    * @exception IllegalArgumentException If the given URI string
 213    * violates RFC 2396
 214    * @exception NullPointerException If uri is null
 215    */
 216   public URI resolve (String str)
 217     throws IllegalArgumentException
 218   {
 219     return null;
 220   }
 221
 222   /**
 223    * Relativizes the given URI against this URI
 224    *
 225    * @param uri The URI to relativize this URI
 226    *
 227    * @return The resulting URI
 228    *
 229    * @exception NullPointerException If uri is null
 230    */
 231   public URI relativize (URI uri)
 232   {
 233     return null;
 234   }
 235
 236   /**
 237    * Creates an URL from an URI
 238    *
 239    * @exception MalformedURLException If a protocol handler for the URL could
 240    * not be found, or if some other error occurred while constructing the URL
 241    * @exception IllegalArgumentException If the URI is not absolute
 242    */
 243   public URL toURL ()
 244     throws IllegalArgumentException, MalformedURLException
 245   {
 246     return null;
 247   }
 248
 249   /**
 250    * Returns the scheme of the URI
 251    */
 252   public String getScheme ()
 253   {
 254     return scheme;
 255   }
 256
 257   /**
 258    * Tells whether this URI is absolute or not
 259    */
 260   public boolean isAbsolute ()
 261   {
 262     return false;
 263   }
 264
 265   /**
 266    * Tell whether this URI is opaque or not
 267    */
 268   public boolean isOpaque ()
 269   {
 270     return false;
 271   }
 272
 273   /**
 274    * Returns the raw scheme specific part of this URI.
 275    * The scheme-specific part is never undefined, though it may be empty
 276    */
 277   public String getRawSchemeSpecificPart ()
 278   {
 279     return null;
 280   }
 281
 282   /**
 283    * Returns the decoded scheme specific part of this URI.
 284    */
 285   public String getSchemeSpecificPart ()
 286   {
 287     return null;
 288   }
 289
 290   /**
 291    * Returns the rae authority part of this URI
 292    */
 293   public String getRawAuthority ()
 294   {
 295     return authority;
 296   }
 297
 298   /**
 299    * Returns the decoded authority part of this URI
 300    */
 301   public String getAuthority ()
 302   {
 303     return null;
 304   }
 305
 306   /**
 307    * Returns the raw user info part of this URI
 308    */
 309   public String getRawUserInfo ()
 310   {
 311     return userInfo;
 312   }
 313
 314   /**
 315    * Returns the decoded user info part of this URI
 316    */
 317   public String getUserInfo ()
 318   {
 319     return null;
 320   }
 321
 322   /**
 323    * Returns the hostname of the URI
 324    */
 325   public String getHost ()
 326   {
 327     return host;
 328   }
 329
 330   /**
 331    * Returns the port number of the URI
 332    */
 333   public int getPort ()
 334   {
 335     return port;
 336   }
 337
 338   /**
 339    * Returns the raw path part of this URI
 340    */
 341   public String getRawPath ()
 342   {
 343     return path;
 344   }
 345
 346   /**
 347    * Returns the path of the URI
 348    */
 349   public String getPath ()
 350   {
 351     return null;
 352   }
 353
 354   /**
 355    * Returns the raw query part of this URI
 356    */
 357   public String getRawQuery ()
 358   {
 359     return query;
 360   }
 361
 362   /**
 363    * Returns the query of the URI
 364    */
 365   public String getQuery ()
 366   {
 367     return null;
 368   }
 369
 370   /**
 371    * Return the raw fragment part of this URI
 372    */
 373   public String getRawFragment ()
 374   {
 375     return fragment;
 376   }
 377
 378   /**
 379    * Returns the fragment of the URI
 380    */
 381   public String getFragment ()
 382   {
 383     return null;
 384   }
 385
 386   /**
 387    * Compares the URI with a given object
 388    *
 389    * @param obj The obj to compare the URI with
 390    */
 391   public boolean equals(Object obj)
 392   {
 393     return false;
 394   }
 395
 396   /**
 397    * Computes the hascode of the URI
 398    */
 399   public int hashCode ()
 400   {
 401     return 0;
 402   }
 403
 404   /**
 405    * Compare the URI with another object that must be an URI too
 406    *
 407    * @param obj This object to compare this URI with
 408    *
 409    * @exception ClassCastException If given object ist not an URI
 410    */
 411   public int compareTo (Object obj)
 412     throws ClassCastException
 413   {
 414     return 0;
 415   }
 416
 417   /**
 418    * Returns the URI as string
 419    */
 420   public String toString ()
 421   {
 422     return "";
 423   }
 424
 425   /**
 426    * Returns the URI as US-ASCII string
 427    */
 428   public String toASCIIString ()
 429   {
 430     return "";
 431   }
 432 }