- /*
- * @(#)FieldDoc.java 1.7 02/10/01
- *
- * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
- * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- */
-
- package com.sun.javadoc;
-
- /**
- * Represents a field in a java class.
- *
- * @see MemberDoc
- *
- * @since JDK1.2
- * @author Robert Field
- */
- public interface FieldDoc extends MemberDoc {
-
- /**
- * Get type of this field.
- */
- Type type();
-
- /**
- * Return true if this field is transient
- */
- boolean isTransient();
-
- /**
- * Return true if this field is volatile
- */
- boolean isVolatile();
-
- /**
- * Return the serialField tags in this FieldDoc item.
- *
- * @return an array of <tt>SerialFieldTag</tt> objects containing
- * all <code>@serialField</code> tags.
- */
- SerialFieldTag[] serialFieldTags();
-
- /**
- * Get the value of a constant field.
- *
- * @return the value of a constant field. The value is
- * automatically wrapped in an object if it has a primitive type.
- * If the field is not constant, returns null.
- */
- Object constantValue();
-
- /**
- * Get the value of a constant field.
- *
- * @return the text of a Java language expression whose value
- * is the value of the constant. The expression uses no identifiers
- * other than primitive literals. If the field is
- * not constant, returns null.
- */
- String constantValueExpression();
- }