1/* 2 * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved. 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 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 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 * 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. 24 */ 25 26package 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 * @deprecated 47 * The declarations in this package have been superseded by those 48 * in the package {@code jdk.javadoc.doclet}. 49 * For more information, see the <i>Migration Guide</i> in the documentation for that package. 50 */ 51@Deprecated 52public interface SerialFieldTag extends Tag, Comparable<Object> { 53 54 /** 55 * Return the serializable field name. 56 * 57 * @return the serializable field name. 58 */ 59 public String fieldName(); 60 61 /** 62 * Return the field type string. 63 * 64 * @return the field type string. 65 */ 66 public String fieldType(); 67 68 /** 69 * Return the ClassDoc for field type. 70 * 71 * @return null if no ClassDoc for field type is visible from 72 * containingClass context. 73 */ 74 public ClassDoc fieldTypeDoc(); 75 76 /** 77 * Return the field comment. If there is no serialField comment, return 78 * javadoc comment of corresponding FieldDoc. 79 * 80 * @return the field comment. If there is no serialField comment, return 81 * javadoc comment of corresponding FieldDoc. 82 */ 83 public String description(); 84 85 /** 86 * Compares this Object with the specified Object for order. Returns a 87 * negative integer, zero, or a positive integer as this Object is less 88 * than, equal to, or greater than the given Object. 89 * <p> 90 * Included to make SerialFieldTag items java.lang.Comparable. 91 * 92 * @param obj the {@code Object} to be compared. 93 * @return a negative integer, zero, or a positive integer as this Object 94 * is less than, equal to, or greater than the given Object. 95 * @exception ClassCastException the specified Object's type prevents it 96 * from being compared to this Object. 97 * @since 1.2 98 */ 99 public int compareTo(Object obj); 100} 101