com.combex.e.edoc
Class ESerialFieldTag

java.lang.Object
  |
  +--com.combex.e.edoc.ETag
        |
        +--com.combex.e.edoc.ESerialFieldTag

All Implemented Interfaces:

Comparable, Marker, PassByConstruction, com.sun.javadoc.SerialFieldTag, Serializable, com.sun.javadoc.Tag

class ESerialFieldTag

extends ETag

implements com.sun.javadoc.SerialFieldTag, Comparable

Documents a Serializable field defined by an ObjectStreamField.

 The class parses and stores the three serialField tag parameters:

 - field name
 - field type name
      (fully-qualified or visible from the current import context)
 - description of the valid values for the field

 

This tag is only allowed in the javadoc for the special member serialPersistentFields.

Author:

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

See Also:

java.io.ObjectStreamField

Field Summary

private com.sun.javadoc.ClassDoc	myContainingClass
private String	myDescription
private String	myFieldName
private String	myFieldType
private com.sun.javadoc.ClassDoc	myFieldTypeDoc
(package private) EDoc	myHolder
private EFieldDoc	myMatchingField
(package private) String	myName
(package private) String	myText

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

HONORARY, HONORED_NAMES, serialVersionUID

Constructor Summary

(package private)

ESerialFieldTag(EDoc holder, String name, String text)

Method Summary

int	compareTo(Object obj) Compares this Object with the specified Object for order.
String	description() Return the field comment.
(package private) String[]	divideAtWhite() for use by subclasses which have two part tag text.
String	fieldName() Return the serialziable field name.
String	fieldType() Return the field type string.
com.sun.javadoc.ClassDoc	fieldTypeDoc() Return the EClassDoc for field type.
com.sun.javadoc.Tag[]	firstSentenceTags() Return array of tags for the first sentence in the doc comment text.
(package private) EFieldDoc	getMatchingField() Return the corresponding EFieldDoc for this ESerialFieldTag.
com.sun.javadoc.Tag[]	inlineTags() For documentation comment with embedded @link tags, return the array of TagImpls consisting of ESeeTag(s) and text containing ETag(s).
(package private) String	key() return a key for sorting.
String	kind() Return the kind of this tag.
(package private) void	mapToFieldDocImpl(EFieldDoc fd)
String	name() Return the name of this tag.
private void	parseSerialFieldString(com.sun.javadoc.Doc holder)
com.sun.javadoc.SourcePosition	position() Need for 1.4
String	qualifiedDocName() Return the qualified name of this tags' doc item.
String	text() Return the text of this tag, that is, portion beyond tag name.
String	toString() Convert this object to a string.

Methods inherited from class java.lang.Object

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

Field Detail

myFieldName

private String myFieldName

myFieldType

private String myFieldType

myDescription

private String myDescription

myContainingClass

private final com.sun.javadoc.ClassDoc myContainingClass

myFieldTypeDoc

private com.sun.javadoc.ClassDoc myFieldTypeDoc

myMatchingField

private EFieldDoc myMatchingField

myText

final String myText

myName

final String myName

myHolder

final EDoc myHolder

Constructor Detail

ESerialFieldTag

ESerialFieldTag(EDoc holder,
                String name,
                String text)

Method Detail

parseSerialFieldString

private void parseSerialFieldString(com.sun.javadoc.Doc holder)

key

String key()

return a key for sorting.

mapToFieldDocImpl

void mapToFieldDocImpl(EFieldDoc fd)

fieldName

public String fieldName()

Return the serialziable field name.

fieldType

public String fieldType()

Return the field type string.

fieldTypeDoc

public com.sun.javadoc.ClassDoc fieldTypeDoc()

Return the EClassDoc for field type.

getMatchingField

EFieldDoc getMatchingField()

Return the corresponding EFieldDoc for this ESerialFieldTag.

description

public String description()

Return the field comment. If there is no serialField comment, return javadoc comment of corresponding EFieldDoc.

kind

public String kind()

Return the kind of this tag.

Overrides:

kind in class ETag

toString

public String toString()

Convert this object to a string.

Overrides:

toString in class ETag

Returns:

a string representation of the object.

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 to make ESerialFieldTag items 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.

Since:

JDK1.2

name

public String name()

Return the name of this tag.

text

public String text()

Return the text of this tag, that is, portion beyond tag name.

divideAtWhite

String[] divideAtWhite()

for use by subclasses which have two part tag text.

inlineTags

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

For documentation comment with embedded @link tags, return the array of TagImpls consisting of ESeeTag(s) and text containing ETag(s). Within a comment string "This is an example of inline tags for a documentaion comment commentlabel", where inside the inner braces, the first "Doc" carries exctly the same syntax as a ESeeTag and the second "commentlabel" is label for the Html Link, will return an array of ETag(s) with first element as ETag with comment text "This is an example of inline tags for a documentation comment" and second element as ESeeTag with referenced class as "Doc" and the label for the Html Link as "commentlabel".

Returns:

ETag[] Array of tags with inline SeeTagImpls.

See Also:

EParamTag, EThrowsTag

firstSentenceTags

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

Return array of tags for the first sentence in the doc comment text.

qualifiedDocName

public String qualifiedDocName()

Return the qualified name of this tags' doc item.

position

public com.sun.javadoc.SourcePosition position()

Need for 1.4