Eclipse JDT Plug-in Developer Guide (Galileo) - SingleMemberAnnotation (Eclipse JDT API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse JDT
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jdt.core.dom
Class SingleMemberAnnotation


java.lang.Object
  

org.eclipse.jdt.core.dom.ASTNode
      

org.eclipse.jdt.core.dom.Expression
          

org.eclipse.jdt.core.dom.Annotation
              
org.eclipse.jdt.core.dom.SingleMemberAnnotation

All Implemented Interfaces:: IExtendedModifier

public final class SingleMemberAnnotation
extends Annotation
extends Annotation

Single member annotation node (added in JLS3 API). The single member annotation "@foo(bar)" is equivalent to the normal annotation "@foo(value=bar)".

 SingleMemberAnnotation:
   @ TypeName ( Expression  )

Within annotations, only certain kinds of expressions are meaningful, including other annotations.

Since:: 3.1
Restriction:: This class is not intended to be instantiated by clients.

Field Summary

static ChildPropertyDescriptor TYPE_NAME_PROPERTY
          The "typeName" structural property of this node type.

static ChildPropertyDescriptor VALUE_PROPERTY
          The "value" structural property of this node type.

Fields inherited from class org.eclipse.jdt.core.dom. ASTNode

ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DO_STATEMENT, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, NORMAL_ANNOTATION, NULL_LITERAL, NUMBER_LITERAL, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, QUALIFIED_NAME, QUALIFIED_TYPE, RECOVERED, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_PARAMETER, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE

Method Summary

Expression getValue ()
          Returns the value of this annotation.

static List propertyDescriptors (int apiLevel)
          Returns a list of structural property descriptors for this node type.

void setValue ( Expression value)
          Sets the value of this annotation.

Methods inherited from class org.eclipse.jdt.core.dom. Annotation

getTypeName, getTypeNameProperty, isAnnotation, isMarkerAnnotation, isModifier, isNormalAnnotation, isSingleMemberAnnotation, resolveAnnotationBinding, setTypeName

Methods inherited from class org.eclipse.jdt.core.dom. Expression

resolveBoxing, resolveConstantExpressionValue, resolveTypeBinding, resolveUnboxing

Methods inherited from class org.eclipse.jdt.core.dom. ASTNode

accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString

Methods inherited from class java.lang. Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_NAME_PROPERTY

public static final 
ChildPropertyDescriptor TYPE_NAME_PROPERTY

The "typeName" structural property of this node type.

VALUE_PROPERTY

public static final 
ChildPropertyDescriptor VALUE_PROPERTY

The "value" structural property of this node type.

Method Detail

propertyDescriptors

public static 
List propertyDescriptors(int apiLevel)

Returns a list of structural property descriptors for this node type. Clients must not modify the result.

Parameters:: apiLevel - the API level; one of the AST.JLS* constants
Returns:: a list of property descriptors (element type: StructuralPropertyDescriptor)

getValue

public 
Expression getValue()

Returns the value of this annotation.

Returns:: the value node

setValue

public void setValue(
Expression value)

Sets the value of this annotation.

Parameters:

value - the new value

Throws:


IllegalArgumentException

- if:

the node belongs to a different AST
the node already has a parent
a cycle in would be created