diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/db/IString.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/db/IString.java index f799766b37a..cdf7d20ea12 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/db/IString.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/pdom/db/IString.java @@ -20,17 +20,67 @@ import org.eclipse.core.runtime.CoreException; * @author Doug Schaefer */ public interface IString { - + /** + * Get the offset of this IString record in the PDOM + * @return + */ public int getRecord(); // strcmp equivalents + /** + * Compare this IString record and the specified IString record + * @param chars + * @return
+ * N.B. This method can be expensive: compare and equals can be used for + * efficient comparisons + * @return an equivalent character array to this IString record + * @throws CoreException + */ public char[] getChars() throws CoreException; + + /** + * Get an equivalent String object to this IString record
+ * N.B. This method can be expensive: compare and equals can be used for + * efficient comparisons + * @return an equivalent String object to this IString record + * @throws CoreException + */ public String getString() throws CoreException; + /** + * Free the associated record in the PDOM + * @throws CoreException + */ public void delete() throws CoreException; }