1 /* 2 * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.javadoc; 27 28 import com.google.doclava.annotation.Unused; 29 import com.google.doclava.annotation.Used; 30 31 /** 32 * Represents a field in a java class. 33 * 34 * @see MemberDoc 35 * 36 * @since 1.2 37 * @author Robert Field 38 */ 39 public interface FieldDoc extends MemberDoc { 40 41 /** 42 * Get type of this field. 43 */ 44 @Used type()45 Type type(); 46 47 /** 48 * Return true if this field is transient 49 */ 50 @Used isTransient()51 boolean isTransient(); 52 53 /** 54 * Return true if this field is volatile 55 */ 56 @Used isVolatile()57 boolean isVolatile(); 58 59 /** 60 * Return the serialField tags in this FieldDoc item. 61 * 62 * @return an array of <tt>SerialFieldTag</tt> objects containing 63 * all <code>@serialField</code> tags. 64 */ 65 @Unused serialFieldTags()66 SerialFieldTag[] serialFieldTags(); 67 68 /** 69 * Get the value of a constant field. 70 * 71 * @return the value of a constant field. The value is 72 * automatically wrapped in an object if it has a primitive type. 73 * If the field is not constant, returns null. 74 */ 75 @Used constantValue()76 Object constantValue(); 77 78 /** 79 * Get the value of a constant field. 80 * 81 * @return the text of a Java language expression whose value 82 * is the value of the constant. The expression uses no identifiers 83 * other than primitive literals. If the field is 84 * not constant, returns null. 85 */ 86 @Unused constantValueExpression()87 String constantValueExpression(); 88 } 89