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

Class DocFile

java.lang.Object
org.hibernate.tool.internal.export.doc.DocFile
public class DocFile extends Object
Represents a documentation file.
Author:
Ricardo C. Moral

  • Constructor Details

    • DocFile

      public DocFile(String pName, DocFolder pFolder)
      Constructor.
      Parameters:
      pName - the name of the file.
      pFolder - the parent folder.
      Throws:
      IllegalArgumentException - if one of the parameters is null.

  • Method Details

    • getName

      public String getName()
      Returns the name of the file.
      Returns:
      the name of the file.

    • getFolder

      public DocFolder getFolder()
      Return the parent DocFolder.
      Returns:
      the DocFolder.

    • getFile

      public File getFile()
      Returns the File representation.
      Returns:
      the File.

    • getPathFolders

      public List<DocFolder> getPathFolders()
      Returns a list with the folders from root.
      Returns:
      a list with the folders from root.

    • buildRefTo

      public String buildRefTo(DocFile target)
      Return a path-like reference to the specified file.
      Parameters:
      target - the target file.
      Returns:
      a path-like reference string.

    • toString

      public String toString()
      Return a String representation of this file.
      Overrides:
      toString in class Object
      Returns:
      a String.