org.simBio.util.taglets
Class Languages

java.lang.Object
  org.simBio.util.taglets.Languages

Direct Known Subclasses:

EnOff, EnOn, JaOff, JaOn

public abstract class Languages
extends java.lang.Object

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 java.lang.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 java.lang.String	toString(Tag tag) Given the Tag representation of this custom tag, return its string representation.

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 java.lang.String getName()

Return the name of the custom tag.

inField

public boolean inField()

Returns:

true since this tag can be used in a field doc comment

inConstructor

public boolean inConstructor()

Returns:

true since this tag can be used in a constructor doc comment

inMethod

public boolean inMethod()

Returns:

true since this tag can be used in a method doc comment

inOverview

public boolean inOverview()

Returns:

true since this tag can be used in an overview doc comment

inPackage

public boolean inPackage()

Returns:

true since this tag can be used in a package doc comment

inType

public boolean inType()

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.

Returns:

true since this is an inline tag.

toString

public abstract java.lang.String toString(Tag tag)

Given the Tag representation of this custom tag, return its string representation.

Parameters:

tag - the Tag representation of this custom tag.