com.combex.e.edoc
Class EMemberDoc

java.lang.Object
  |
  +--com.combex.e.edoc.EDoc
        |
        +--com.combex.e.edoc.EProgramElementDoc
              |
              +--com.combex.e.edoc.EMemberDoc

All Implemented Interfaces:

Comparable, com.sun.javadoc.Doc, Marker, com.sun.javadoc.MemberDoc, PassByConstruction, com.sun.javadoc.ProgramElementDoc, Serializable

Direct Known Subclasses:

EExecutableMemberDoc, EFieldDoc

abstract class EMemberDoc

extends EProgramElementDoc

implements com.sun.javadoc.MemberDoc

Represents a member of a java class: field, constructor, or method. This is an abstract class dealing with information common to method, constructor and field members. Class members of a class (innerclasses) are represented instead by EClassDoc.

Author:

Robert Field, mods by Mark Miller of combex.com subject to the terms of Sun's SCSL license.

See Also:

EMethodDoc, EFieldDoc, EClassDoc

Field Summary

(package private) EClassDoc	myContainingClass
private boolean	myIsIncluded
(package private) int	myModifiers
private String	myName

Fields inherited from interface org.erights.e.elib.serial.PassByConstruction

HONORARY, HONORED_NAMES, serialVersionUID

Constructor Summary

EMemberDoc(EDocBuilder builder, com.sun.javadoc.MemberDoc memberDoc)

EMemberDoc(String documentation, int modifiers, EClassDoc containingClass, String name, boolean included)

Method Summary

abstract int	arity()
(package private) boolean	checkAccess() Hook so we can allow unfiltered access, with a yet to be determined API addition.
(package private) EComment	comment() For lazy initialization of comment.
String	commentText() Return the text of the comment for this doc item.
int	compareTo(Object obj) Compares this Object with the specified Object for order.
com.sun.javadoc.ClassDoc	containingClass() Get the containing class of this program element.
com.sun.javadoc.PackageDoc	containingPackage() Return the package that this member is contained in.
com.sun.javadoc.Tag[]	firstSentenceTags()
(package private) java.text.CollationKey	generateKey() generate a key for sorting.
String	getRawCommentText() Return the full unprocessed text of the comment.
com.sun.javadoc.Tag[]	inlineTags()
boolean	isClass() Is this Doc item a class.
boolean	isConstructor() Is this Doc item a constructor? False until overridden.
boolean	isError() Is this Doc item a error class? False until overridden.
boolean	isException() Is this Doc item a exception class? False until overridden.
boolean	isField() Is this Doc item a field? False until overridden.
boolean	isFinal() Return true if this program element is final
boolean	isIncluded() return true if this member is included in the active set.
boolean	isInterface() Is this Doc item a interface? False until overridden.
boolean	isMethod() Is this Doc item a simple method (i.e.
boolean	isOrdinaryClass() Is this Doc item a ordinary class (i.e.
boolean	isPackagePrivate() Return true if this program element is package private
boolean	isPrivate() Return true if this program element is private
boolean	isProtected() Return true if this program element is protected
boolean	isPublic() Return true if this program element is public
boolean	isStatic() Return true if this program element is static
boolean	isSynthetic() Returns true if this field was synthesized by the compiler.
(package private) java.text.CollationKey	key() return a key for sorting.
static ArrayList	list(Object[] array)
String	modifiers() Get modifiers string.
int	modifierSpecifier() Get the modifier specifier integer.
String	name() Get the name.
com.sun.javadoc.SourcePosition	position() Need for 1.4
String	qualifiedName() Get the name.
(package private) String	readHTMLDocumentation(InputStream input, String filename) Utility for subclasses which read HTML documentation files.
com.sun.javadoc.SeeTag[]	seeTags() Return the see also tags in this Doc item.
void	setRawCommentText(String rawDocumentation) Set the full unprocessed text of the comment.
com.sun.javadoc.Tag[]	tags() Return all tags in this Doc item.
com.sun.javadoc.Tag[]	tags(String tagname) Return tags of the specified kind in this Doc item.
(package private) EClassDoc	thisClassDocImpl()
(package private) String	toQualifiedString() Returns the qualified string representation of this Doc item.
String	toString() Returns a string representation of the member.
abstract String	typedVerb()
static EDoc[]	visible(List list, Class memType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

myName

private final String myName

myIsIncluded

private final boolean myIsIncluded

myModifiers

final int myModifiers

myContainingClass

final EClassDoc myContainingClass

Constructor Detail

EMemberDoc

public EMemberDoc(EDocBuilder builder,
                  com.sun.javadoc.MemberDoc memberDoc)

EMemberDoc

public EMemberDoc(String documentation,
                  int modifiers,
                  EClassDoc containingClass,
                  String name,
                  boolean included)

Method Detail

typedVerb

public abstract String typedVerb()

arity

public abstract int arity()

thisClassDocImpl

EClassDoc thisClassDocImpl()

Overrides:

thisClassDocImpl in class EDoc

qualifiedName

public String qualifiedName()

Get the name.

Returns:

the qualified name of the member.

name

public String name()

Get the name.

Specified by:

name in class EDoc

Returns:

the unqualified name of the member.

containingPackage

public com.sun.javadoc.PackageDoc containingPackage()

Return the package that this member is contained in. Return "" if in empty package.

isIncluded

public boolean isIncluded()

return true if this member is included in the active set.

Specified by:

isIncluded in class EDoc

isSynthetic

public boolean isSynthetic()

Returns true if this field was synthesized by the compiler.

toString

public String toString()

Returns a string representation of the member.

Overrides:

toString in class EDoc

Returns:

a description of the member

toQualifiedString

String toQualifiedString()

Description copied from class: EDoc

Returns the qualified string representation of this Doc item.

Overrides:

toQualifiedString in class EDoc

Returns:

the qualified name.

containingClass

public com.sun.javadoc.ClassDoc containingClass()

Get the containing class of this program element.

Returns:

a EClassDoc for this element's containing class. If this is a class with no outer class, return null.

modifierSpecifier

public int modifierSpecifier()

Get the modifier specifier integer.

See Also:

java.lang.reflect.Modifier

modifiers

public String modifiers()

Get modifiers string.

 Example, for:
   public abstract int foo() { ... }
 modifiers() would return:
   'public abstract'
 

isPublic

public boolean isPublic()

Return true if this program element is public

isProtected

public boolean isProtected()

Return true if this program element is protected

isPrivate

public boolean isPrivate()

Return true if this program element is private

isPackagePrivate

public boolean isPackagePrivate()

Return true if this program element is package private

isStatic

public boolean isStatic()

Return true if this program element is static

isFinal

public boolean isFinal()

Return true if this program element is final

list

public static ArrayList list(Object[] array)

comment

EComment comment()

For lazy initialization of comment.

checkAccess

boolean checkAccess()

Hook so we can allow unfiltered access, with a yet to be determined API addition.

commentText

public String commentText()

Return the text of the comment for this doc item. TagImpls have been removed.

tags

public com.sun.javadoc.Tag[] tags()

Return all tags in this Doc item.

Returns:

an array of Tag containing all tags on this Doc item.

tags

public com.sun.javadoc.Tag[] tags(String tagname)

Return tags of the specified kind in this Doc item.

Parameters:

tagname - name of the tag kind to search for.

Returns:

an array of ETag containing all tags whose 'kind()' matches 'tagname'.

seeTags

public com.sun.javadoc.SeeTag[] seeTags()

Return the see also tags in this Doc item.

Returns:

an array of SeeTag containing all @see tags.

inlineTags

public com.sun.javadoc.Tag[] inlineTags()

firstSentenceTags

public com.sun.javadoc.Tag[] firstSentenceTags()

readHTMLDocumentation

String readHTMLDocumentation(InputStream input,
                             String filename)
                       throws IOException

Utility for subclasses which read HTML documentation files.

IOException

getRawCommentText

public String getRawCommentText()

Return the full unprocessed text of the comment. Tags are included as text. Used mainly for store and retrieve operations like internalization.

setRawCommentText

public void setRawCommentText(String rawDocumentation)

Set the full unprocessed text of the comment. Tags are included as text. Used mainly for store and retrieve operations like internalization.

key

java.text.CollationKey key()

return a key for sorting.

generateKey

java.text.CollationKey generateKey()

generate a key for sorting.

default is toString();

compareTo

public int compareTo(Object obj)

Compares this Object with the specified Object for order. Returns a negative integer, zero, or a positive integer as this Object is less than, equal to, or greater than the given Object.

Included so that Doc item are java.lang.Comparable.

Specified by:

compareTo in interface Comparable

Parameters:

obj - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this Object is less than, equal to, or greater than the given Object.

Throws:

ClassCastException - the specified Object's type prevents it from being compared to this Object.

isField

public boolean isField()

Is this Doc item a field? False until overridden.

Returns:

true if it represents a field

isMethod

public boolean isMethod()

Is this Doc item a simple method (i.e. not a constructor)? False until overridden.

Returns:

true is it represents a method, false if it is anything else, including constructor, field, class, ...

isConstructor

public boolean isConstructor()

Is this Doc item a constructor? False until overridden.

Returns:

true is it represents a constructor

isInterface

public boolean isInterface()

Is this Doc item a interface? False until overridden.

Returns:

true is it represents a interface

isException

public boolean isException()

Is this Doc item a exception class? False until overridden.

Returns:

true is it represents a exception

isError

public boolean isError()

Is this Doc item a error class? False until overridden.

Returns:

true is it represents a error

isOrdinaryClass

public boolean isOrdinaryClass()

Is this Doc item a ordinary class (i.e. not an interface, exception, or error)? False until overridden.

Returns:

true is it represents a class

isClass

public boolean isClass()

Is this Doc item a class. Note: interfaces are not classes. False until overridden.

Returns:

true is it represents a class

visible

public static EDoc[] visible(List list,
                             Class memType)

position

public com.sun.javadoc.SourcePosition position()

Need for 1.4