signatures

Identifier:

com.ibm.xtools.emf.core.signatures

Since:

7.0

Description:

This extension point defines a signature and allows clients to bind content types and editing domains to the signature. The binding will ensure that all resources that match one of the content types or editing domains will be serialized with the signature information. This information can be used to alert users when they are opening a resource that contains the signature of a component that is not available in their runtime. Signatures through their version information also create an entry point for the backward compatibility framework.

Configuration Markup:

<!ELEMENT extension (signature* , signature-association*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT signature (feature-association+)>

<!ATTLIST signature

id CDATA #REQUIRED

version CDATA #REQUIRED>

This declares the signature information and associates the signature with one or more installed features.

id - The unique id for the signature. Reverse domain naming should be used for this field. No spaces are allowed.
version - The version of the signature in the same format as plugin versions (major.minor.service.qualifier, major.minor.service, major.minor or major). See org.eclipse.core.runtime.PluginVersionIdentifier.

<!ELEMENT signature-association EMPTY>

<!ATTLIST signature-association

contentTypeIds CDATA #IMPLIED

editingDomainIds CDATA #IMPLIED

signatureId CDATA #REQUIRED>

This tag associates a signature with content types and/or editing domains.

contentTypeIds - A comma-separated list of content types ids
editingDomainIds - A comma-separated list of editing domain ids
signatureId - The id of the signature that is being associated

<!ELEMENT feature-association EMPTY>

<!ATTLIST feature-association

version CDATA #REQUIRED

url CDATA #IMPLIED

name CDATA #REQUIRED>

Associates a signature with a particular feature. A feature name must be provided. A feature version must be provided. The URL and description are optional but highly recommended. See com.ibm.xtools.emf.core.signature.IFeatureDescription for more information.

version - The version of the feature being associated. The qualifier part is ignored when matching this feature version against the features installed into the runtime.
url - This url should be a human-readable URL that a user could use to learn more about aquiring the necessary feature to make their resources load properly.
name - The name (or ID) of the installable feature.

Examples:

API Information:

See the IFeatureDescription and UnknownSignatureDiagnostic classes for more information.