JavaDocTag.SerialField (NetBeans Java Hierarchy API) - NetBeans API Javadoc 4.1.0

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.openide.src
Interface JavaDocTag.SerialField

All Superinterfaces:: JavaDocTag

Enclosing interface:: JavaDocTag

public static interface JavaDocTag.SerialField
extends JavaDocTag

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

See Also:: ObjectStreamField

Nested Class Summary

Nested classes inherited from class org.openide.src.JavaDocTag

JavaDocTag.Param, JavaDocTag.See, JavaDocTag.SerialField, JavaDocTag.Throws

Method Summary

String description()
          Return the field comment.

String fieldName()
          Return the serialziable field name.

String fieldType()
          Return the field type string.

Methods inherited from interface org.openide.src.JavaDocTag

kind, name, text

Method Detail

fieldName

public String fieldName()

Return the serialziable field name.

fieldType

public String fieldType()

Return the field type string.

description

public String description()

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