FieldDoc


1   /*
2    * @(#)FieldDoc.java    1.7 02/10/01
3    *
4    * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5    * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6    */
7   
8   package com.sun.javadoc;
9   
10  /**
11   * Represents a field in a java class.
12   *
13   * @see MemberDoc
14   *
15   * @since JDK1.2
16   * @author Robert Field
17   */
18  public interface FieldDoc extends MemberDoc {
19  
20      /**
21       * Get type of this field.
22       */
23      Type type();
24  
25      /**
26       * Return true if this field is transient
27       */
28      boolean isTransient();
29  
30      /**
31       * Return true if this field is volatile
32       */
33      boolean isVolatile();
34  
35      /**
36       * Return the serialField tags in this FieldDoc item.
37       *
38       * @return an array of <tt>SerialFieldTag</tt> objects containing
39       *         all <code>@serialField</code> tags.
40       */
41      SerialFieldTag[] serialFieldTags();
42  
43      /**
44       * Get the value of a constant field.
45       *
46       * @return the value of a constant field. The value is
47       * automatically wrapped in an object if it has a primitive type.
48       * If the field is not constant, returns null.
49       */
50      Object   constantValue();
51  
52      /**
53       * Get the value of a constant field.
54       *
55       * @return the text of a Java language expression whose value
56       * is the value of the constant. The expression uses no identifiers
57       * other than primitive literals. If the field is 
58       * not constant, returns null.
59       */
60      String   constantValueExpression();
61  }
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags