• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/javadoc/SerialFieldTag.java@2eb010b6cb22 (annotated)

src/share/classes/com/sun/javadoc/SerialFieldTag.java

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 1372

78962d89f283

parent 0

959103a6100f

permissions

-rw-r--r--

merge

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