ResourceUri (JavaDocs for mmm-all dev-SNAPSHOT)

All Known Implementing Classes:: ResourceUriImpl

public interface ResourceUri

This interface represents an URI pointing to the location of a DataResource. A ResourceUri can be represented as string but consists of two parts: a scheme-prefix and a path.
Here are some examples:

`URI`	`scheme-prefix`	`path`
file:///tmp/config.xml	file://	/tmp/config.xml
http://m-m-m.sourceforge.net/maven/index.html	http://	m-m-m.sourceforge.net/maven/index.html
classpath:net/sf/mmm/util/beans-core.xml	classpath:	net/sf/mmm/util/beans-core.xml
/home/mmm/.profile	<null>	/home/mmm/.profile
../foo/bar.ext	<null>	../foo/bar.ext
C:\WINDOWS\system32\drivers\etc\hosts	<null>	C:\WINDOWS\system32\drivers\etc\hosts

Since:: 2.0.0
Author:: Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SCHEME_PREFIX_CLASSPATH` The `scheme prefix` for a `Path` on the classpath (see `ClassLoader` for details).
`static String`	`SCHEME_PREFIX_FILE` The `scheme prefix` for a `Path` on the regular `FileSystem` (see `File`).
`static String`	`SCHEME_PREFIX_FTP` The `scheme prefix` for a `Path` on the network accessed via FTP.
`static String`	`SCHEME_PREFIX_HTTP` The `scheme prefix` for a `Path` on the web accessed via HTTP.
`static String`	`SCHEME_PREFIX_HTTPS` The `scheme prefix` for a `Path` on the web accessed via HTTPS.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getPath()` This method gets the path of this `ResourceUri`.
`String`	`getSchemePrefix()` This method gets the scheme-prefix of a qualified `ResourceUri`.
`String`	`getUri()` This method gets this `ResourceUri` as string.
`String`	`toString()`

- Field Detail
  - SCHEME_PREFIX_FILE
```
static final String SCHEME_PREFIX_FILE
```
    The scheme prefix for a Path on the regular FileSystem (see File).
    
    See Also:
    
    Constant Field Values
  - SCHEME_PREFIX_CLASSPATH
```
static final String SCHEME_PREFIX_CLASSPATH
```
    The scheme prefix for a Path on the classpath (see ClassLoader for details).
    
    See Also:
    
    Constant Field Values
  - SCHEME_PREFIX_HTTP
```
static final String SCHEME_PREFIX_HTTP
```
    The scheme prefix for a Path on the web accessed via HTTP.
    
    See Also:
    
    Constant Field Values
  - SCHEME_PREFIX_HTTPS
```
static final String SCHEME_PREFIX_HTTPS
```
    The scheme prefix for a Path on the web accessed via HTTPS.
    
    See Also:
    
    Constant Field Values
  - SCHEME_PREFIX_FTP
```
static final String SCHEME_PREFIX_FTP
```
    The scheme prefix for a Path on the network accessed via FTP.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getUri
```
String getUri()
```
    This method gets this ResourceUri as string.
    
    Returns:
    
    the URI as string.
  - getSchemePrefix
```
String getSchemePrefix()
```
    This method gets the scheme-prefix of a qualified ResourceUri. The scheme-prefix has the following form: [a-zA-Z][a-zA-Z0-9\\.\\-+]+:(//)?. The part before the colon (:) is called the scheme.
    Examples for scheme-prefixes are:
    - classpath:
    - file://
    - http://
    - https://
    - ftp://
    Returns:
    
    the schemePrefix or null if this ResourceUri is unqualified.
  - getPath
```
String getPath()
```
    This method gets the path of this ResourceUri. This is the part of the URI after the scheme-prefix.
    
    Returns:
    
    the path.
  - toString
```
String toString()
```
    Overrides:
    
    toString in class Object

Interface ResourceUri

Field Summary

Method Summary

Field Detail

SCHEME_PREFIX_FILE

SCHEME_PREFIX_CLASSPATH

SCHEME_PREFIX_HTTP

SCHEME_PREFIX_HTTPS

SCHEME_PREFIX_FTP

Method Detail

getUri

getSchemePrefix

getPath

toString