com.combex.e.edoc
Class EPackageDoc

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

All Implemented Interfaces:

Comparable, com.sun.javadoc.Doc, Marker, com.sun.javadoc.PackageDoc, PassByConstruction, Serializable

class EPackageDoc

extends EDoc

implements com.sun.javadoc.PackageDoc

Field Summary

private List	myClasses all classes in this package
(package private) boolean	myIsIncluded
private String	myName

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

HONORARY, HONORED_NAMES, serialVersionUID

Constructor Summary

EPackageDoc(EDocBuilder builder, com.sun.javadoc.PackageDoc pDoc)

Method Summary

(package private) void	addAllClassesTo(List list) Add all included classes (including Exceptions and Errors) and interfaces.
(package private) void	addClass(EClassDoc cd)
com.sun.javadoc.ClassDoc[]	allClasses() Get all classes (including Exceptions and Errors) and interfaces.
com.sun.javadoc.ClassDoc[]	allClasses(boolean filter) Need for 1.4
(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[]	errors() Get Error classes in this package.
com.sun.javadoc.ClassDoc[]	exceptions() Get Exception classes in this package.
com.sun.javadoc.ClassDoc	findClass(String className) Lookup for a class within this package.
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()
com.sun.javadoc.ClassDoc[]	interfaces() Get Interfaces in this package.
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	isIncluded() return true if this package 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.
(package private) java.text.CollationKey	key() return a key for sorting.
static ArrayList	list(Object[] array)
String	name() Get package name.
com.sun.javadoc.ClassDoc[]	ordinaryClasses() Get ordinary classes (excluding Exceptions and Errors) in this package.
com.sun.javadoc.SourcePosition	position() Need for 1.4
(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 package.
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

myClasses

private final List myClasses

all classes in this package

myIsIncluded

boolean myIsIncluded

Constructor Detail

EPackageDoc

public EPackageDoc(EDocBuilder builder,
                   com.sun.javadoc.PackageDoc pDoc)

Method Detail

addClass

void addClass(EClassDoc cd)

name

public String name()

Get package name.

Specified by:

name in class EDoc

Returns:

the name

addAllClassesTo

void addAllClassesTo(List list)

Add all included classes (including Exceptions and Errors) and interfaces.

allClasses

public com.sun.javadoc.ClassDoc[] allClasses()

Get all classes (including Exceptions and Errors) and interfaces.

Returns:

all included classes and interfaces in this package.

ordinaryClasses

public com.sun.javadoc.ClassDoc[] ordinaryClasses()

Get ordinary classes (excluding Exceptions and Errors) in this package.

Returns:

included classes in this package.

exceptions

public com.sun.javadoc.ClassDoc[] exceptions()

Get Exception classes in this package.

Returns:

included Exceptions in this package.

errors

public com.sun.javadoc.ClassDoc[] errors()

Get Error classes in this package.

Returns:

included Errors in this package.

interfaces

public com.sun.javadoc.ClassDoc[] interfaces()

Get Interfaces in this package.

Returns:

included Errors in this package.

findClass

public com.sun.javadoc.ClassDoc findClass(String className)

Lookup for a class within this package.

Returns:

EClassDoc of found class, or null if not found.

isIncluded

public boolean isIncluded()

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

Specified by:

isIncluded in class EDoc

toString

public String toString()

Returns a string representation of the package.

Overrides:

toString in class EDoc

Returns:

the package name.

allClasses

public com.sun.javadoc.ClassDoc[] allClasses(boolean filter)

Need for 1.4

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.

thisClassDocImpl

EClassDoc thisClassDocImpl()

key

java.text.CollationKey key()

return a key for sorting.

generateKey

java.text.CollationKey generateKey()

generate a key for sorting.

default is toString();

toQualifiedString

String toQualifiedString()

Returns the qualified string representation of this Doc item.

Returns:

the qualified name.

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