1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/src/share/classes/com/sun/javadoc/SerialFieldTag.java Wed Apr 27 01:34:52 2016 +0800 1.3 @@ -0,0 +1,87 @@ 1.4 +/* 1.5 + * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved. 1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 1.7 + * 1.8 + * This code is free software; you can redistribute it and/or modify it 1.9 + * under the terms of the GNU General Public License version 2 only, as 1.10 + * published by the Free Software Foundation. Oracle designates this 1.11 + * particular file as subject to the "Classpath" exception as provided 1.12 + * by Oracle in the LICENSE file that accompanied this code. 1.13 + * 1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT 1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1.17 + * version 2 for more details (a copy is included in the LICENSE file that 1.18 + * accompanied this code). 1.19 + * 1.20 + * You should have received a copy of the GNU General Public License version 1.21 + * 2 along with this work; if not, write to the Free Software Foundation, 1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 1.23 + * 1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 1.25 + * or visit www.oracle.com if you need additional information or have any 1.26 + * questions. 1.27 + */ 1.28 + 1.29 +package com.sun.javadoc; 1.30 + 1.31 +/** 1.32 + * Documents a Serializable field defined by an ObjectStreamField. 1.33 + * <pre> 1.34 + * The class parses and stores the three serialField tag parameters: 1.35 + * 1.36 + * - field name 1.37 + * - field type name 1.38 + * (fully-qualified or visible from the current import context) 1.39 + * - description of the valid values for the field 1.40 + 1.41 + * </pre> 1.42 + * This tag is only allowed in the javadoc for the special member 1.43 + * serialPersistentFields. 1.44 + * 1.45 + * @author Joe Fialli 1.46 + * 1.47 + * @see java.io.ObjectStreamField 1.48 + */ 1.49 +public interface SerialFieldTag extends Tag, Comparable<Object> { 1.50 + 1.51 + /** 1.52 + * Return the serializable field name. 1.53 + */ 1.54 + public String fieldName(); 1.55 + 1.56 + /** 1.57 + * Return the field type string. 1.58 + */ 1.59 + public String fieldType(); 1.60 + 1.61 + /** 1.62 + * Return the ClassDoc for field type. 1.63 + * 1.64 + * @return null if no ClassDoc for field type is visible from 1.65 + * containingClass context. 1.66 + */ 1.67 + public ClassDoc fieldTypeDoc(); 1.68 + 1.69 + /** 1.70 + * Return the field comment. If there is no serialField comment, return 1.71 + * javadoc comment of corresponding FieldDoc. 1.72 + */ 1.73 + public String description(); 1.74 + 1.75 + /** 1.76 + * Compares this Object with the specified Object for order. Returns a 1.77 + * negative integer, zero, or a positive integer as this Object is less 1.78 + * than, equal to, or greater than the given Object. 1.79 + * <p> 1.80 + * Included to make SerialFieldTag items java.lang.Comparable. 1.81 + * 1.82 + * @param obj the <code>Object</code> to be compared. 1.83 + * @return a negative integer, zero, or a positive integer as this Object 1.84 + * is less than, equal to, or greater than the given Object. 1.85 + * @exception ClassCastException the specified Object's type prevents it 1.86 + * from being compared to this Object. 1.87 + * @since 1.2 1.88 + */ 1.89 + public int compareTo(Object obj); 1.90 +}