org.simBio.util.taglets
Class Languages

java.lang.Object
  extended by org.simBio.util.taglets.Languages
All Implemented Interfaces:
com.sun.tools.doclets.Taglet
Direct Known Subclasses:
EnOff, EnOn, JaOff, JaOn

public abstract class Languages
extends Object
implements com.sun.tools.doclets.Taglet

Abstract super class for languages inline taglets.

Version:
$Id: Languages.java,v 1.1 2007/12/17 01:46:12 mikaelwing Exp $
Author:
Mikael Wing

Constructor Summary
Languages()
           
 
Method Summary
abstract  String getName()
          Return the name of the custom tag.
 boolean inConstructor()
           
 boolean inField()
           
 boolean inMethod()
           
 boolean inOverview()
           
 boolean inPackage()
           
 boolean inType()
           
 boolean isInlineTag()
          Will return true since this is an inline tag.
abstract  String toString(com.sun.javadoc.Tag tag)
          Given the Tag representation of this custom tag, return its string representation.
 String toString(com.sun.javadoc.Tag[] tags)
          This method should not be called since arrays of inline tags do not exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Languages

public Languages()
Method Detail

getName

public abstract String getName()
Return the name of the custom tag.

Specified by:
getName in interface com.sun.tools.doclets.Taglet

inField

public boolean inField()
Specified by:
inField in interface com.sun.tools.doclets.Taglet
Returns:
true since this tag can be used in a field doc comment

inConstructor

public boolean inConstructor()
Specified by:
inConstructor in interface com.sun.tools.doclets.Taglet
Returns:
true since this tag can be used in a constructor doc comment

inMethod

public boolean inMethod()
Specified by:
inMethod in interface com.sun.tools.doclets.Taglet
Returns:
true since this tag can be used in a method doc comment

inOverview

public boolean inOverview()
Specified by:
inOverview in interface com.sun.tools.doclets.Taglet
Returns:
true since this tag can be used in an overview doc comment

inPackage

public boolean inPackage()
Specified by:
inPackage in interface com.sun.tools.doclets.Taglet
Returns:
true since this tag can be used in a package doc comment

inType

public boolean inType()
Specified by:
inType in interface com.sun.tools.doclets.Taglet
Returns:
true since this tag can be used in an type doc comment

isInlineTag

public boolean isInlineTag()
Will return true since this is an inline tag.

Specified by:
isInlineTag in interface com.sun.tools.doclets.Taglet
Returns:
true since this is an inline tag.

toString

public abstract String toString(com.sun.javadoc.Tag tag)
Given the Tag representation of this custom tag, return its string representation.

Specified by:
toString in interface com.sun.tools.doclets.Taglet
Parameters:
tag - the Tag representation of this custom tag.

toString

public String toString(com.sun.javadoc.Tag[] tags)
This method should not be called since arrays of inline tags do not exist. Method #tostring(Tag) should be used to convert this inline tag to a string.

Specified by:
toString in interface com.sun.tools.doclets.Taglet
Parameters:
tags - the array of Tags representing of this custom tag.


Copyright © 2005 Cell/Biodinamics simulation project. All Rights Reserved.