duke@1: /*
duke@1:  * Copyright 1998-2006 Sun Microsystems, Inc.  All Rights Reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.javadoc;
duke@1: 
duke@1: /**
duke@1:  * Documents a Serializable field defined by an ObjectStreamField.
duke@1:  * <pre>
duke@1:  * The class parses and stores the three serialField tag parameters:
duke@1:  *
duke@1:  * - field name
duke@1:  * - field type name
duke@1:  *      (fully-qualified or visible from the current import context)
duke@1:  * - description of the valid values for the field
duke@1: 
duke@1:  * </pre>
duke@1:  * This tag is only allowed in the javadoc for the special member
duke@1:  * serialPersistentFields.
duke@1:  *
duke@1:  * @author Joe Fialli
duke@1:  *
duke@1:  * @see java.io.ObjectStreamField
duke@1:  */
duke@1: public interface SerialFieldTag extends Tag, Comparable<Object> {
duke@1: 
duke@1:     /**
duke@1:      * Return the serialziable field name.
duke@1:      */
duke@1:     public String fieldName();
duke@1: 
duke@1:     /**
duke@1:      * Return the field type string.
duke@1:      */
duke@1:     public String fieldType();
duke@1: 
duke@1:     /**
duke@1:      * Return the ClassDoc for field type.
duke@1:      *
duke@1:      * @return null if no ClassDoc for field type is visible from
duke@1:      *         containingClass context.
duke@1:      */
duke@1:     public ClassDoc fieldTypeDoc();
duke@1: 
duke@1:     /**
duke@1:      * Return the field comment. If there is no serialField comment, return
duke@1:      * javadoc comment of corresponding FieldDoc.
duke@1:      */
duke@1:     public String description();
duke@1: 
duke@1:     /**
duke@1:      * Compares this Object with the specified Object for order.  Returns a
duke@1:      * negative integer, zero, or a positive integer as this Object is less
duke@1:      * than, equal to, or greater than the given Object.
duke@1:      * <p>
duke@1:      * Included to make SerialFieldTag items java.lang.Comparable.
duke@1:      *
duke@1:      * @param   obj the <code>Object</code> to be compared.
duke@1:      * @return  a negative integer, zero, or a positive integer as this Object
duke@1:      *          is less than, equal to, or greater than the given Object.
duke@1:      * @exception ClassCastException the specified Object's type prevents it
duke@1:      *            from being compared to this Object.
duke@1:      * @since 1.2
duke@1:      */
duke@1:     public int compareTo(Object obj);
duke@1: }