Package com.wavemaker.commons.io

Class JailedResourcePath

java.lang.Object

com.wavemaker.commons.io.JailedResourcePath

public final class JailedResourcePath
extends java.lang.Object

A ResourcePath that is jailed to a specific location.

Constructor Summary

Constructors

Constructor	Description
JailedResourcePath()	Create a new JailedResourcePath with a root jail and root path.
JailedResourcePath(ResourcePath jailPath, ResourcePath path)	Create a new JailedResourcePath instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
JailedResourcePath	get(java.lang.String path)	Get a new path relative to this one.
ResourcePath	getJailPath()	Returns the jail path.
JailedResourcePath	getParent()	Returns the parent JailedResourcePath of this instance or null if there is no parent.
ResourcePath	getPath()	Returns the path.
ResourcePath	getUnjailedPath()	Returns the complete unjailed path
int	hashCode()
java.lang.String	toString()	Return the path string.
java.lang.String	toString(ResourceStringFormat format)
JailedResourcePath	unjail()	Unjail the specified resource path

Methods inherited from class java.lang.Object

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

Constructor Detail

JailedResourcePath

public JailedResourcePath(ResourcePath jailPath,
                          ResourcePath path)

Create a new JailedResourcePath instance.

Parameters:

jailPath - the jail path

path - the path

JailedResourcePath

public JailedResourcePath()

Create a new JailedResourcePath with a root jail and root path.

Method Detail

getJailPath

public ResourcePath getJailPath()

Returns the jail path.

Returns:

the jail

getPath

public ResourcePath getPath()

Returns the path.

Returns:

the path

getParent

public JailedResourcePath getParent()

Returns the parent JailedResourcePath of this instance or null if there is no parent.

Returns:

the parent.

get

public JailedResourcePath get(java.lang.String path)

Get a new path relative to this one.

Parameters:

path - the path

Returns:

a new JailedResourcePath

getUnjailedPath

public ResourcePath getUnjailedPath()

Returns the complete unjailed path

Returns:

the unjailed path

unjail

public JailedResourcePath unjail()

Unjail the specified resource path

Returns:

the unjailed version

toString

public java.lang.String toString()

Return the path string.

Overrides:

toString in class java.lang.Object

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(ResourceStringFormat format)