KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > javadoc > SerialFieldTag


1 /*
2  * @(#)SerialFieldTag.java 1.9 04/05/05
3  *
4  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */
7
8 package com.sun.javadoc;
9
10 /**
11  * Documents a Serializable field defined by an ObjectStreamField.
12  * <pre>
13  * The class parses and stores the three serialField tag parameters:
14  *
15  * - field name
16  * - field type name
17  * (fully-qualified or visible from the current import context)
18  * - description of the valid values for the field
19
20  * </pre>
21  * This tag is only allowed in the javadoc for the special member
22  * serialPersistentFields.
23  *
24  * @author Joe Fialli
25  *
26  * @see java.io.ObjectStreamField
27  */
28 public interface SerialFieldTag extends Tag, Comparable JavaDoc<Object JavaDoc> {
29
30     /**
31      * Return the serialziable field name.
32      */
33     public String JavaDoc fieldName();
34
35     /**
36      * Return the field type string.
37      */
38     public String JavaDoc fieldType();
39
40     /**
41      * Return the ClassDoc for field type.
42      *
43      * @return null if no ClassDoc for field type is visible from
44      * containingClass context.
45      */
46     public ClassDoc fieldTypeDoc();
47
48     /**
49      * Return the field comment. If there is no serialField comment, return
50      * javadoc comment of corresponding FieldDoc.
51      */
52     public String JavaDoc description();
53
54     /**
55      * Compares this Object with the specified Object for order. Returns a
56      * negative integer, zero, or a positive integer as this Object is less
57      * than, equal to, or greater than the given Object.
58      * <p>
59      * Included to make SerialFieldTag items java.lang.Comparable.
60      *
61      * @param obj the <code>Object</code> to be compared.
62      * @return a negative integer, zero, or a positive integer as this Object
63      * is less than, equal to, or greater than the given Object.
64      * @exception ClassCastException the specified Object's type prevents it
65      * from being compared to this Object.
66      * @since JDK1.2
67      */
68     public int compareTo(Object JavaDoc obj);
69 }
70
Popular Tags