1 /*
   2  * Copyright 2004 Sun Microsystems, Inc.  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.  Sun designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  22  * CA 95054 USA or visit www.sun.com if you need additional information or
  23  * have any questions.
  24  */
  25 
  26 package com.sun.mirror.declaration;
  27 
  28 
  29 import com.sun.mirror.type.TypeMirror;
  30 
  31 
  32 /**
  33  * Represents a field of a type declaration.
  34  *
  35  * @deprecated All components of this API have been superseded by the
  36  * standardized annotation processing API.  The replacement for the
  37  * functionality of this interface is included in {@link
  38  * javax.lang.model.element.VariableElement}.
  39  *
  40  * @author Joseph D. Darcy
  41  * @author Scott Seligman
  42  * @since 1.5
  43  */
  44 @Deprecated
  45 @SuppressWarnings("deprecation")
  46 public interface FieldDeclaration extends MemberDeclaration {
  47 
  48     /**
  49      * Returns the type of this field.
  50      *
  51      * @return the type of this field
  52      */
  53     TypeMirror getType();
  54 
  55     /**
  56      * Returns the value of this field if this field is a compile-time
  57      * constant.  Returns <tt>null</tt> otherwise.
  58      * The value will be of a primitive type or <tt>String</tt>.
  59      * If the value is of a primitive type, it is wrapped in the
  60      * appropriate wrapper class (such as {@link Integer}).
  61      *
  62      * @return the value of this field if this field is a compile-time
  63      * constant, or <tt>null</tt> otherwise
  64      */
  65     Object getConstantValue();
  66 
  67     /**
  68      * Returns the text of a <i>constant expression</i> representing the
  69      * value of this field if this field is a compile-time constant.
  70      * Returns <tt>null</tt> otherwise.
  71      * The value will be of a primitive type or <tt>String</tt>.
  72      * The text returned is in a form suitable for representing the value
  73      * in source code.
  74      *
  75      * @return the text of a constant expression if this field is a
  76      *          compile-time constant, or <tt>null</tt> otherwise
  77      */
  78     String getConstantExpression();
  79 }