Class FileURIId

java.lang.Object

net.okapia.osid.primordium.id.spi.AbstractId

net.okapia.osid.primordium.id.FileURIId

All Implemented Interfaces:

Serializable, Id, OsidPrimitive, Id, OsidPrimitive

public final class FileURIId
extends AbstractId
implements Id

Defines an Id using a file based URI scheme for local identifiers.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FileURIId(String path)	Creates a new FileURIId for localhost from an absolute path name.

Method Summary

Modifier and Type	Method	Description
String	formatLabel()	Converts an OSID Id into a URI.
static Id	id(String path)	Returns an Id from an absolute path name.
static Id	id(URI uri)	Returns an Id from a file based URI.
static Id	valueOf(String path)	Returns an Id from an absolute path name.
static Id	valueOf(URI uri)	Returns an Id from a file based URI.

Methods inherited from class AbstractId

equals, getAuthority, getIdentifier, getIdentifierNamespace, hashCode, toString

Modifier and Type	Method	Description
final boolean	equals(Object obj)	Determines if the given Id is equal to this one.
final String	getAuthority()	Gets the authority of this Id.
final String	getIdentifier()	Gets the identifier of this Id.
final String	getIdentifierNamespace()	Gets the namespace of the identifier.
final int	hashCode()	Returns a hash code value for this Id based on the authority, namespace and identifier.
String	toString()	Returns a string representation of this Id.

Methods inherited from class Object

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

Constructor Details

FileURIId

public FileURIId(String path)

Creates a new FileURIId for localhost from an absolute path name.

Parameters:

path - the path

Throws:

NullArgumentException - null argument provided

Method Details

valueOf

public static Id valueOf(String path)

Returns an Id from an absolute path name.

Parameters:

path - the absolute path to include as the identifier

Returns:

an Id with the string components

Throws:

NullArgumentException - path is null

See Also:

• id(String)

valueOf

public static Id valueOf(URI uri)

Returns an Id from a file based URI.

Parameters:

uri - the URI

Returns:

an Id with the string components

Throws:

InvalidArgumentException - cannot parse file uri because uri protocol is not file or host is not localhost

NullArgumentException - uri is null

See Also:

• id(java.net.URI)

id

public static Id id(String path)

Returns an Id from an absolute path name.

Parameters:

path - the absolute path to include as the identifier

Returns:

an Id with the string components

Throws:

NullArgumentException - path is null

See Also:

• valueOf(String)

id

public static Id id(URI uri)

Returns an Id from a file based URI.

Parameters:

uri - the URI

Returns:

an Id with the string components

Throws:

InvalidArgumentException - cannot parse file uri because uri protocol is not file or host is not localhost

NullArgumentException - uri is null

See Also:

• valueOf(java.net.URI)

formatLabel

public String formatLabel()

Converts an OSID Id into a URI.

Specified by:

formatLabel in class AbstractId

Returns:

formatted string