Annotation Tag Info
Identifier:
org.eclipse.jst.common.annotations.controller.AnnotationTagInfo
Since:
This extension point is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.
Description:
Describes the tags contained by a tag set and the tag's attributes.
Configuration Markup:
<!ELEMENT extension (AnnotationTagInfo+)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - a fully qualified identifier of the target extension point
- id - an optional identifier of the extension instance
- name - an optional name of the extension instance
<!ELEMENT AnnotationTagInfo (attrib*)>
<!ATTLIST AnnotationTagInfo
tagSet CDATA #REQUIRED
tagName CDATA #REQUIRED
scope (type|method|field)
multiplicity (1|*) "1"
description CDATA #IMPLIED>
- tagSet - Name of the tag set this tag comes underneath. ( for instance, if we're defining the
@ejb.bean
tag, then the tag set would be ejb
. ) The tag set must have been defined using the annotation.tagset extension point.
- tagName - Name of the tag. ( if we're defining the
@ejb.bean
tag, then the tagName would be bean
).
- scope - Scope of the bean. Must be
type
,method
, or field
.
- multiplicity - Multiplicity of the tagset. Must be
1
or*
. The default value is 1, if not specified.
- description - Optional description. May be a description string, or a
key to localized text for the description in the declaring plugin's resource bundle. No default if this is
not specified.
<!ELEMENT attrib (unique? , enumValues*)>
<!ATTLIST attrib
name CDATA #REQUIRED
description CDATA #IMPLIED
use (optional|required) "optional"
type (string|bool|javaType|enum) "string">
- name - Name of the attribute.
- description - Description text for the attribute, or key pointing to the localized description text inside of the declaring plugin's resource bundle. If not specified, defaults to
ath.ATTRIBUTE_NAME
.
- use - Sets whether this tag is
optional
or required
. The default is optional
.
- type - Type of the attribute,
string|boolean|javaType
. Defaults to string
if not specified.
<!ELEMENT unique EMPTY>
<!ATTLIST unique
scope (module|file|type|method|field) "module">
Specifies that the attribute value is unique within the specified scope.
- scope - The scope of the uniqueness for the attribute value. It is one of the
module
, file
, type
, method
,or field
. The default value is 'module'.
<!ELEMENT enumValues EMPTY>
<!ATTLIST enumValues
value CDATA #REQUIRED>
- value - This can be used to supply the user a drop down choice of values for a specific attribute selection. Each one of these "values" is an entry in that drop down for the selected attribute.
Copyright (c) 2005 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html