|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JTag
Represents a javadoc tag. Includes helper methods for parsing tags containing complex name-value data. Different folks have different styles of encoding the pairs, so we provide different helper methods.
Method Summary | |
---|---|
java.lang.String |
getName()
Returns the name of the tag. |
java.util.Properties |
getProperties_lineDelimited()
Convenience method which parses the tag's contents as a series of line-delimited name=value pairs and returns them as a properties object. |
java.util.Properties |
getProperties_whitespaceDelimited()
Convenience method which parses the tag's contents as a series of whitespace-delimited name=value pairs and returns them as a properties object. |
java.lang.String |
getText()
Returns the raw contents of the tag, as return by javadoc's Tag.text() method. |
Methods inherited from interface org.codehaus.jam.JElement |
---|
accept, getArtifact, getParent, getQualifiedName, getSimpleName, getSourcePosition, isSourceAvailable, toString |
Method Detail |
---|
java.lang.String getName()
java.lang.String getText()
java.util.Properties getProperties_lineDelimited()
Convenience method which parses the tag's contents as a series of line-delimited name=value pairs and returns them as a properties object. A line break is the only delimter between pairs, and the first '=' is taken as the delimeter between name and value.
For example, a javadoc tag 'my tag' with the following value: (at)mytag foo = this bar = "and" that baz = the other thing = truewould be returned as a Properties object containing three properties named foo, bar, and baz with values of "this", ""and"" that, and "the other thing = true", respectively.
java.util.Properties getProperties_whitespaceDelimited()
Convenience method which parses the tag's contents as a series of whitespace-delimited name=value pairs and returns them as a properties object. Values containing whitespace must be quoted. Keys may not contain whitespace
For example, a javadoc tag 'my tag' with the following contents: (at)mytag foo = this bar = that this text is ignored baz = "but not this"would be returned as a Properties object containing three properties named foo, bar, and baz with values of "this", "that", and "but not this".
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |