org.inria.ns.reflex.javadoc
Class Relativizer

java.lang.Object
  extended by org.inria.ns.reflex.javadoc.Relativizer

public class Relativizer
extends Object

A tool that relativize paths from a Java file to the Javadoc root.

Author:
Philippe Poulard

Method Summary
static String getPath(SourcePosition position)
          Return the relative path that allow to retrieve the Javadoc root from a given position.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getPath

public static String getPath(SourcePosition position)
Return the relative path that allow to retrieve the Javadoc root from a given position.

For example, if the source position is the file org/inria/ns/reflex/foo/Bar.java, the path returned is ../../../...

Parameters:
position - The origin position.
Returns:
The path where is located the Javadoc root, or null if the position is not localizable, or if the Javadoc root is not localizable.