author | poonam |
Tue, 26 Feb 2013 08:58:20 -0800 | |
changeset 15808 | c75f11af1033 |
parent 14357 | faf9cde2817b |
child 23136 | aa8958a4c8f4 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
5520
diff
changeset
|
2 |
* Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved. |
10 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5520 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
10 | 24 |
*/ |
25 |
||
26 |
package com.sun.javadoc; |
|
27 |
||
28 |
/** |
|
29 |
* Documents a Serializable field defined by an ObjectStreamField. |
|
30 |
* <pre> |
|
31 |
* The class parses and stores the three serialField tag parameters: |
|
32 |
* |
|
33 |
* - field name |
|
34 |
* - field type name |
|
35 |
* (fully-qualified or visible from the current import context) |
|
36 |
* - description of the valid values for the field |
|
37 |
||
38 |
* </pre> |
|
39 |
* This tag is only allowed in the javadoc for the special member |
|
40 |
* serialPersistentFields. |
|
41 |
* |
|
42 |
* @author Joe Fialli |
|
43 |
* |
|
44 |
* @see java.io.ObjectStreamField |
|
45 |
*/ |
|
46 |
public interface SerialFieldTag extends Tag, Comparable<Object> { |
|
47 |
||
48 |
/** |
|
14357
faf9cde2817b
8000741: refactor javadoc to use abstraction to handle relative paths
jjg
parents:
5520
diff
changeset
|
49 |
* Return the serializable field name. |
10 | 50 |
*/ |
51 |
public String fieldName(); |
|
52 |
||
53 |
/** |
|
54 |
* Return the field type string. |
|
55 |
*/ |
|
56 |
public String fieldType(); |
|
57 |
||
58 |
/** |
|
59 |
* Return the ClassDoc for field type. |
|
60 |
* |
|
61 |
* @return null if no ClassDoc for field type is visible from |
|
62 |
* containingClass context. |
|
63 |
*/ |
|
64 |
public ClassDoc fieldTypeDoc(); |
|
65 |
||
66 |
/** |
|
67 |
* Return the field comment. If there is no serialField comment, return |
|
68 |
* javadoc comment of corresponding FieldDoc. |
|
69 |
*/ |
|
70 |
public String description(); |
|
71 |
||
72 |
/** |
|
73 |
* Compares this Object with the specified Object for order. Returns a |
|
74 |
* negative integer, zero, or a positive integer as this Object is less |
|
75 |
* than, equal to, or greater than the given Object. |
|
76 |
* <p> |
|
77 |
* Included to make SerialFieldTag items java.lang.Comparable. |
|
78 |
* |
|
79 |
* @param obj the <code>Object</code> to be compared. |
|
80 |
* @return a negative integer, zero, or a positive integer as this Object |
|
81 |
* is less than, equal to, or greater than the given Object. |
|
82 |
* @exception ClassCastException the specified Object's type prevents it |
|
83 |
* from being compared to this Object. |
|
84 |
* @since 1.2 |
|
85 |
*/ |
|
86 |
public int compareTo(Object obj); |
|
87 |
} |