ydoc.resolvers
Interface PathResolver

All Known Implementing Classes:
ydoc.resolvers.DefaultDiagramLocator
public interface PathResolver

A path resolver is responsible for associating documentation elements (RootDoc, PackageDoc, ClassDoc) to file system locations of corresponding UML diagrams.

Note:
To be loaded and used by doclets at run-time, the path resolver must have a non-argument constructor.

 

Method Summary
 File getPathTo(ClassDoc cd)
          Given a documentation class, return the full path to the class diagram.
 File getPathTo(ClassDoc cd, String id, String ext)
          Given a documentation class, return the full path to the class diagram.
 File getPathTo(PackageDoc pd)
          Given a documentation package, return the full path to the package diagram.
 File getPathTo(PackageDoc pd, String id, String ext)
          Given a documentation package, return the full path to the package diagram.
 File getPathTo(RootDoc rd)
          Given the documentation root, return the full path to the overview diagram.
 File getPathTo(RootDoc rd, String id, String ext)
          Given the documentation root, return the full path to the overview diagram.
 File getRootDirectory()
          Returns property rootDirectory.
 void setRootDirectory(File directory)
          Sets property rootDirectory.
 

Method Detail

getRootDirectory

File getRootDirectory()
Returns property rootDirectory.

Returns:
property rootDirectory.

setRootDirectory

void setRootDirectory(File directory)
Sets property rootDirectory.

Parameters:
directory - the path to the root directory

getPathTo

File getPathTo(RootDoc rd)
Given the documentation root, return the full path to the overview diagram. This method may return null, if no appropriate diagram can be found.

Parameters:
rd - the RootDoc.

getPathTo

File getPathTo(RootDoc rd,
               String id,
               String ext)
Given the documentation root, return the full path to the overview diagram. This method may return null, if no appropriate diagram can be found.

Parameters:
rd - the RootDoc.
id - file name suffix which identifies a diagram if multiple diagrams are generated. May be null.
ext - file extension. May be null.

getPathTo

File getPathTo(PackageDoc pd)
Given a documentation package, return the full path to the package diagram. This method may return null, if no appropriate diagram can be found.

Parameters:
pd - the PackageDoc.

getPathTo

File getPathTo(PackageDoc pd,
               String id,
               String ext)
Given a documentation package, return the full path to the package diagram. This method may return null, if no appropriate diagram can be found.

Parameters:
pd - the PackageDoc.
id - file name suffix which identifies a diagram if multiple diagrams are generated. May be null.
ext - file extension. May be null.

getPathTo

File getPathTo(ClassDoc cd)
Given a documentation class, return the full path to the class diagram. This method may return null, if no appropriate diagram can be found.

Parameters:
cd - the ClassDoc.

getPathTo

File getPathTo(ClassDoc cd,
               String id,
               String ext)
Given a documentation class, return the full path to the class diagram. This method may return null, if no appropriate diagram can be found.

Parameters:
cd - the ClassDoc.
id - file name suffix which identifies a diagram if multiple diagrams are generated. May be null.
ext - file extension. May be null.