import eclipse 3.1 M4 compiler
[org.ibex.tool.git] / src / org / eclipse / jdt / internal / compiler / env / IDependent.java
index bf645ec..91b5b4a 100644 (file)
@@ -18,15 +18,26 @@ package org.eclipse.jdt.internal.compiler.env;
  * when file dependencies are collected.
  */
 public interface IDependent {
+       char JAR_FILE_ENTRY_SEPARATOR = '|';
 /**
  * Answer the file name which defines the type.
  *
  * The path part (optional) must be separated from the actual
- * file proper name by a java.io.File.separator.
+ * file proper name by a separator suitable for the type (java.io.File.separator for example),
+ * e.g.
+ *  "c:\\source\\com\\p\\X.java" or
+ *  "/com/p/Y.java".
+ * 
+ * The path to the zip or jar file (optional) must be separated
+ * from the actual path part by JAR_FILE_ENTRY_SEPARATOR,
+ * e.g.
+ *  "c:\\lib\\some.jar|/com/p/X.class" or
+ *  "/lib/some.zip|/com/q/Y.class".
  *
  * The proper file name includes the suffix extension (e.g. ".java")
- *
- * e.g. "c:/com/ibm/compiler/java/api/Compiler.java" 
+ * e.g. "c:/org/eclipse/jdt/internal/compileri/env/IDependent.java" 
+ * 
+ * Return null if no file defines the type.
  */
 
 char[] getFileName();