|
WEB4J Development Tools 4.10.0.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Objecthirondelle.web4jtools.taglet.SqlTaglet
public final class SqlTaglet
Taglet for linking to .sql files.
The .sql files need to be copied into the javadoc tree. The typical use case is to place the .sql file in the same directory as the class that references it.
Example 1 :
&sql statements.sql
Example 2 :
&sql ../blah/statements.sql
This references a file in a nearby directory.
Example 3 :
&sql statements.sql ADD_BLAH, CHANGE_BLAH
This example references two specific SQL statements in the statements.sql file. That is, it references only a subset of the statements in the file.
Constructor Summary | |
---|---|
SqlTaglet()
|
Method Summary | |
---|---|
String |
getName()
Return 'sql'. |
boolean |
inConstructor()
Returns false. |
boolean |
inField()
Returns false. |
boolean |
inMethod()
Returns false. |
boolean |
inOverview()
Returns false. |
boolean |
inPackage()
Returns false. |
boolean |
inType()
Returns true. |
boolean |
isInlineTag()
Returns false. |
static void |
register(Map aTagletMap)
Register this taglet with the javadoc tool, under the taglet name 'sql'. |
String |
toString(Tag aTag)
Render a single &sql item. |
String |
toString(Tag[] aTags)
Render a series of &sql items. |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SqlTaglet()
Method Detail |
---|
public static void register(Map aTagletMap)
public String getName()
getName
in interface Taglet
public boolean isInlineTag()
isInlineTag
in interface Taglet
public boolean inOverview()
inOverview
in interface Taglet
public boolean inPackage()
inPackage
in interface Taglet
public boolean inType()
inType
in interface Taglet
public boolean inConstructor()
inConstructor
in interface Taglet
public boolean inMethod()
inMethod
in interface Taglet
public boolean inField()
inField
in interface Taglet
public String toString(Tag[] aTags)
toString
in interface Taglet
public String toString(Tag aTag)
toString
in interface Taglet
|
WEB4J Development Tools 4.10.0.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |