Package org.hibernate.tool.internal.export.doc

Class DocFolder

java.lang.Object

org.hibernate.tool.internal.export.doc.DocFolder

public class DocFolder
extends Object

Represents a documentation folder.

Author:

Ricardo C. Moral

Constructor Summary

Constructors

Constructor	Description
DocFolder(File root)	Constructor for the root folder.
DocFolder(String pName, DocFolder pParent)	Constructor.

Method Summary

Modifier and Type	Method	Description
File	getFile()	Return the File instance.
String	getName()	Return the name of this folder.
DocFolder	getParent()	Returns the parent folder.
List<DocFolder>	getPathFolders()	Returns a list with the folders from root.
String	toString()	Return a String representation of this folder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DocFolder

public DocFolder(File root)

Constructor for the root folder.

Parameters:

pFileRoot - the File that represents the root for the documentation.

DocFolder

public DocFolder(String pName,
 DocFolder pParent)

Constructor.

Parameters:

pName - the name of the file.

pParent - the parent folder.

Method Details

getName

public String getName()

Return the name of this folder.

Returns:

the name of this folder.

getParent

public DocFolder getParent()

Returns the parent folder.

Returns:

the parent folder.

getFile

public File getFile()

Return the File instance.

Returns:

the File instance.

getPathFolders

public List<DocFolder> getPathFolders()

Returns a list with the folders from root.

Returns:

a list with the folders from root.

toString

public String toString()

Return a String representation of this folder.

Overrides:

toString in class Object

Returns:

a String.