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