net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/dom/IMemberValuePairBinding.java

   1 /*******************************************************************************
   2  * Copyright (c) 2005, 2008 BEA Systems, Inc.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *    tyeung@bea.com - initial API and implementation
  10  *    IBM Corporation - changed interface to extend IBinding
  11  *    IBM Corporation - renamed from IResolvedMemberValuePair to IMemberValuePairBinding
  12  *******************************************************************************/
  13 package net.sourceforge.phpdt.core.dom;
  14
  15 /**
  16  * Represents a resolved instance of an annotation's member value pair.
  17  * Resolved annotation are computed along with other bindings; these objects
  18  * correspond to {@link MemberValuePair} nodes.
  19  *
  20  * @since 3.2
  21  * @noimplement This interface is not intended to be implemented by clients.
  22  */
  23 public interface IMemberValuePairBinding extends IBinding {
  24 /**
  25  * Returns the name of the annotation type member.
  26  *
  27  * @return the name of the member
  28  */
  29 public String getName();
  30
  31 /**
  32  * Returns the method binding corresponding to the named annotation type member.
  33  *
  34  * @return the method binding for the annotation type member
  35  */
  36 public IMethodBinding getMethodBinding();
  37
  38 /**
  39  * Returns the resolved value. Resolved values are represented as follows:
  40  * <ul>
  41  * <li>Primitive type - the equivalent boxed object</li>
  42  * <li>java.lang.Class - the <code>ITypeBinding</code> for the class object</li>
  43  * <li>java.lang.String - the string value itself</li>
  44  * <li>enum type - the <code>IVariableBinding</code> for the enum constant</li>
  45  * <li>annotation type - an <code>IAnnotationBinding</code></li>
  46  * <li>array type - an <code>Object[]</code> whose elements are as per above
  47  * (the language only allows single dimensional arrays in annotations)</li>
  48  * </ul>
  49  *
  50  * @return the resolved value, or <code>null</code> if none exists
  51  */
  52 public Object getValue();
  53
  54 /**
  55  * @return <code>true</code> iff this member value pair's value is the default value.
  56  *         Returns <code>false</code> otherwise.
  57  */
  58 public boolean isDefault();
  59 }