lumis.portal.filesystem
Class PortalFilePath

java.lang.Object
  lumis.portal.filesystem.PortalFilePath

All Implemented Interfaces:

java.io.Serializable

@StableMinor(version="6.1",
             sinceVersion="4.1")
public final class PortalFilePath
extends java.lang.Object
implements java.io.Serializable

Represents a path to a portal file. It is internally stored as a PortalBaseFolder and a relative path to that folder.

Since:

4.1.0

See Also:

Serialized Form

Constructor Summary

PortalFilePath(PortalBaseFolder baseFolder, java.lang.String relativePath)
Creates a portal file path from a base folder and a relative path.

PortalFilePath(java.lang.String absolutePath)
Creates a portal file path from an absolute path.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getAbsolutePath() Returns the absolute path this instance corresponds to.
PortalBaseFolder	getBaseFolder() Returns the base folder for this path.
java.lang.String	getRelativePath() Returns the relative path to getBaseFolder().
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PortalFilePath

public PortalFilePath(PortalBaseFolder baseFolder,
                      java.lang.String relativePath)

Creates a portal file path from a base folder and a relative path.

Parameters:

baseFolder - the base folder.

relativePath - the relative path, relative to the base folder.

Since:

4.1.0

PortalFilePath

public PortalFilePath(java.lang.String absolutePath)

Creates a portal file path from an absolute path.

Parameters:

absolutePath - the absolute path.

Throws:

java.lang.IllegalArgumentException - if the given absolute path is invalid or does not belongs to an area that may be mapped using a portal file path.

Since:

4.1.0

Method Detail

getAbsolutePath

public java.lang.String getAbsolutePath()

Returns the absolute path this instance corresponds to.

Returns:

the absolute path this instance corresponds to.

Since:

4.1.0

getRelativePath

public java.lang.String getRelativePath()

Returns the relative path to getBaseFolder().

Returns:

the relative path relative to the base folder.

Since:

4.1.0

getBaseFolder

public PortalBaseFolder getBaseFolder()

Returns the base folder for this path.

Returns:

the base folder for this path.

Since:

4.1.0

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object