WEB4J Development Tools 4.10.0.0

hirondelle.web4jtools.taglet
Class SqlTaglet

Object
  extended by hirondelle.web4jtools.taglet.SqlTaglet
All Implemented Interfaces:
Taglet

public final class SqlTaglet
extends Object
implements Taglet

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

SqlTaglet

public SqlTaglet()
Method Detail

register

public static void register(Map aTagletMap)
Register this taglet with the javadoc tool, under the taglet name 'sql'.


getName

public String getName()
Return 'sql'.

Specified by:
getName in interface Taglet

isInlineTag

public boolean isInlineTag()
Returns false.

Specified by:
isInlineTag in interface Taglet

inOverview

public boolean inOverview()
Returns false.

Specified by:
inOverview in interface Taglet

inPackage

public boolean inPackage()
Returns false.

Specified by:
inPackage in interface Taglet

inType

public boolean inType()
Returns true.

Specified by:
inType in interface Taglet

inConstructor

public boolean inConstructor()
Returns false.

Specified by:
inConstructor in interface Taglet

inMethod

public boolean inMethod()
Returns false.

Specified by:
inMethod in interface Taglet

inField

public boolean inField()
Returns false.

Specified by:
inField in interface Taglet

toString

public String toString(Tag[] aTags)
Render a series of &sql items.

Specified by:
toString in interface Taglet

toString

public String toString(Tag aTag)
Render a single &sql item.

Specified by:
toString in interface Taglet

WEB4J Development Tools 4.10.0.0

Copyright Hirondelle Systems - Generated 2013Oct19.12.26