org.weborganic.bastille.psml
Class PSMLFile

java.lang.Object
  org.weborganic.bastille.psml.PSMLFile

All Implemented Interfaces:

Serializable

public final class PSMLFile
extends Object
implements Serializable

A path/file value pair for a PSML document.

See Also:

Serialized Form

Method Summary

boolean	exists() Indicates whether this resource exists.
File	file() The files corresponding to the path.
String	getBase() Returns the base path for the specified PSML.
String	path() The path to the file from the PSML root folder.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

path

public String path()

The path to the file from the PSML root folder.

Returns:

The path to the file from the PSML root folder.

file

public File file()

The files corresponding to the path.

Returns:

The actual file.

getBase

public String getBase()

Returns the base path for the specified PSML.

The base path is the path to the folder for the given PSML file.

Returns:

the base path for the specified PSML folder

Throws:

NullPointerException - if the psml folder is null.

exists

public boolean exists()

Indicates whether this resource exists.

Returns:

true if the file is not null and exists on the file system; false otherwise.

toString

public String toString()

Overrides:

toString in class Object