| 1 |
779 |
jeremybenn |
/* FieldDoc.java -- Document a field
|
| 2 |
|
|
Copyright (C) 1999 Free Software Foundation, Inc.
|
| 3 |
|
|
|
| 4 |
|
|
This file is part of GNU Classpath.
|
| 5 |
|
|
|
| 6 |
|
|
GNU Classpath is free software; you can redistribute it and/or modify
|
| 7 |
|
|
it under the terms of the GNU General Public License as published by
|
| 8 |
|
|
the Free Software Foundation; either version 2, or (at your option)
|
| 9 |
|
|
any later version.
|
| 10 |
|
|
|
| 11 |
|
|
GNU Classpath is distributed in the hope that it will be useful, but
|
| 12 |
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 13 |
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
| 14 |
|
|
General Public License for more details.
|
| 15 |
|
|
|
| 16 |
|
|
You should have received a copy of the GNU General Public License
|
| 17 |
|
|
along with GNU Classpath; see the file COPYING. If not, write to the
|
| 18 |
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
| 19 |
|
|
02110-1301 USA.
|
| 20 |
|
|
|
| 21 |
|
|
Linking this library statically or dynamically with other modules is
|
| 22 |
|
|
making a combined work based on this library. Thus, the terms and
|
| 23 |
|
|
conditions of the GNU General Public License cover the whole
|
| 24 |
|
|
combination.
|
| 25 |
|
|
|
| 26 |
|
|
As a special exception, the copyright holders of this library give you
|
| 27 |
|
|
permission to link this library with independent modules to produce an
|
| 28 |
|
|
executable, regardless of the license terms of these independent
|
| 29 |
|
|
modules, and to copy and distribute the resulting executable under
|
| 30 |
|
|
terms of your choice, provided that you also meet, for each linked
|
| 31 |
|
|
independent module, the terms and conditions of the license of that
|
| 32 |
|
|
module. An independent module is a module which is not derived from
|
| 33 |
|
|
or based on this library. If you modify this library, you may extend
|
| 34 |
|
|
this exception to your version of the library, but you are not
|
| 35 |
|
|
obligated to do so. If you do not wish to do so, delete this
|
| 36 |
|
|
exception statement from your version. */
|
| 37 |
|
|
|
| 38 |
|
|
|
| 39 |
|
|
package com.sun.javadoc;
|
| 40 |
|
|
|
| 41 |
|
|
/**
|
| 42 |
|
|
* This package is used for documenting fields.
|
| 43 |
|
|
*/
|
| 44 |
|
|
public interface FieldDoc extends MemberDoc
|
| 45 |
|
|
{
|
| 46 |
|
|
|
| 47 |
|
|
/**
|
| 48 |
|
|
* This method returns the type of this field.
|
| 49 |
|
|
*
|
| 50 |
|
|
* @return The type of this field.
|
| 51 |
|
|
*/
|
| 52 |
|
|
public abstract Type
|
| 53 |
|
|
type();
|
| 54 |
|
|
|
| 55 |
|
|
/*************************************************************************/
|
| 56 |
|
|
|
| 57 |
|
|
/**
|
| 58 |
|
|
* This method tests whether or not the field is transient.
|
| 59 |
|
|
*
|
| 60 |
|
|
* @return <code>true</code> if the field is transient, <code>false</code>
|
| 61 |
|
|
* otherwise.
|
| 62 |
|
|
*/
|
| 63 |
|
|
public abstract boolean
|
| 64 |
|
|
isTransient();
|
| 65 |
|
|
|
| 66 |
|
|
/*************************************************************************/
|
| 67 |
|
|
|
| 68 |
|
|
/**
|
| 69 |
|
|
* This method tests whether or not the field is volatile.
|
| 70 |
|
|
*
|
| 71 |
|
|
* @return <code>true</code> if the field is volatile, <code>false</code>
|
| 72 |
|
|
* otherwise.
|
| 73 |
|
|
*/
|
| 74 |
|
|
public abstract boolean
|
| 75 |
|
|
isVolatile();
|
| 76 |
|
|
|
| 77 |
|
|
/*************************************************************************/
|
| 78 |
|
|
|
| 79 |
|
|
/**
|
| 80 |
|
|
* This method returns a list of all "@serialField" tags defined in this
|
| 81 |
|
|
* field.
|
| 82 |
|
|
*
|
| 83 |
|
|
* @return The list of "@serialField" tags for this field.
|
| 84 |
|
|
*/
|
| 85 |
|
|
public abstract SerialFieldTag[]
|
| 86 |
|
|
serialFieldTags();
|
| 87 |
|
|
|
| 88 |
|
|
/*************************************************************************/
|
| 89 |
|
|
|
| 90 |
|
|
/**
|
| 91 |
|
|
* This method returns the value of this static field.
|
| 92 |
|
|
*
|
| 93 |
|
|
* @return The value of this static field.
|
| 94 |
|
|
*/
|
| 95 |
|
|
public abstract Object
|
| 96 |
|
|
constantValue();
|
| 97 |
|
|
|
| 98 |
|
|
|
| 99 |
|
|
/*************************************************************************/
|
| 100 |
|
|
|
| 101 |
|
|
/**
|
| 102 |
|
|
* This method returns the value of this static field converted to a
|
| 103 |
|
|
* human-readable string.
|
| 104 |
|
|
*
|
| 105 |
|
|
* @return The value of this static field as a human-readable string.
|
| 106 |
|
|
*/
|
| 107 |
|
|
public abstract String
|
| 108 |
|
|
constantValueExpression();
|
| 109 |
|
|
|
| 110 |
|
|
|
| 111 |
|
|
|
| 112 |
|
|
} // interface FieldDoc
|
