org.kitesdk.data.spi

Class URIPattern

java.lang.Object

org.kitesdk.data.spi.URIPattern

public class URIPattern
extends Object

Defines a URI pattern that can be used to parse and match other URIs.

Since:

0.8.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOST
static String	PASSWORD
static String	PORT
static String	SCHEME
static String	USERNAME

Constructor Summary

Constructors

Constructor and Description
URIPattern(String uri)
URIPattern(URI uri)

Method Summary

Methods

Modifier and Type	Method and Description
URI	construct(Map<String,String> options) Constructs a URI that matches this pattern from the given options.
boolean	equals(Object o)
Map<String,String>	getLastMatch() Returns the parsed results of the last matched URI.
Map<String,String>	getMatch(String uri) Returns results from parsing a URI with this pattern.
Map<String,String>	getMatch(URI uri) Returns results from parsing a URI with this pattern.
String	getPatternString()
String	getScheme()
int	hashCode()
boolean	matches(String uri) Returns true if the URI String matches this pattern.
boolean	matches(URI uri) Returns true if the URI matches this pattern.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SCHEME

public static final String SCHEME

See Also:

Constant Field Values

HOST

public static final String HOST

See Also:

Constant Field Values

PORT

public static final String PORT

See Also:

Constant Field Values

USERNAME

public static final String USERNAME

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

Constant Field Values

Constructor Detail

URIPattern

public URIPattern(URI uri)

URIPattern

public URIPattern(String uri)

Method Detail

getScheme

public String getScheme()

getPatternString

public String getPatternString()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

construct

public URI construct(Map<String,String> options)

Constructs a URI that matches this pattern from the given options.

Parameters:

options - a map of variable and

Returns:

a URI that matches this pattern

Throws:

IllegalArgumentException - if the URI cannot be constructed

matches

public boolean matches(URI uri)

Returns true if the URI matches this pattern. If successful, the variable values are available by calling getLastMatch() (not thread safe).

Parameters:

uri - a String to check against this pattern.

Returns:

true if the String matches this pattern

matches

public boolean matches(String uri)
                throws URISyntaxException

Returns true if the URI String matches this pattern. If successful, the variable values are available by calling getLastMatch() (not thread safe).

Parameters:

uri - a String to check against this pattern.

Returns:

true if the String matches this pattern

Throws:

URISyntaxException - if the String is not a valid URI

getMatch

public Map<String,String> getMatch(URI uri)

Returns results from parsing a URI with this pattern. If the URI doesn't match the pattern, this will return null.

Parameters:

uri - A URI to match against this URIPattern

Returns:

A Map of the pattern's variable names to values from the parsed URI

getMatch

public Map<String,String> getMatch(String uri)
                            throws URISyntaxException

Returns results from parsing a URI with this pattern. If the URI doesn't match the pattern, this will return null.

Parameters:

uri - A URI to match against this URIPattern

Returns:

A Map of the pattern's variable names to values from the parsed URI

Throws:

URISyntaxException - if the String is not a valid URI

getLastMatch

public Map<String,String> getLastMatch()

Returns the parsed results of the last matched URI. Not thread-safe. This is intended as a convenience for single-threaded callers that want to use matches() and not re-parse the URI to get the result.

Returns:

a result map from the last successful match

toString

public String toString()

Overrides:

toString in class Object