Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Eclipse Plug-in Developer Guide
Previous Page Home Next Page

Value Variables

Identifier:
org.eclipse.core.variables.valueVariables

Since:
3.0

Description:
This extension point provides a mechanism for defining variables used for string substitution. A value variable has a static value.

Configuration Markup:

<!ELEMENT extension ( variable*)>

<!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 variable EMPTY>

<!ATTLIST variable

name             CDATA #REQUIRED

readOnly         (true | false)

initialValue     CDATA #IMPLIED

initializerClass CDATA #IMPLIED

description      CDATA #IMPLIED

>

  • name - specifies a unique name for this variable.
  • readOnly - Specifies whether this variable is read only. When true, this variable's value will always be derived from the extension and cannot be edited by the user. When false, this variable's value will be initialized from any initialValue attribtue or initializer class, and can be modified by the user. Once a read-write variable is modified, it's value is persisted and overrides any value specified by an extension's initialValue or initializer class. When unspecified, the value of this attribute is false. This attribute was added in the 3.3 release.
  • initialValue - specifies the initial value for this variable. When specified, an initializerClass attribute must not be specified.
  • initializerClass - specifies the fully qualified name of the Java class that implements org.eclipse.core.variables.IValueVariableInitializer. When specified, an initialValue attribute must not be specified.
  • description - specifies a human-readable description of this variable.

Examples:
The following is an example of a value variable contribution with an initial value:


 <extension point=
"org.eclipse.core.variables.valueVariables"
>
  <variable
   name=
"FOO_HOME"

   initialValue=
"/usr/local/foo"
>
  </variable>
 </extension>

In the example above, the specified variable is created with the initial value "/usr/local/foo". The following is an example of a value variable contribution with an initializer class:


 <extension point=
"org.eclipse.core.variables.valueVariables"
>
  <variable
   name=
"FOO_HOME"

   initializerClass=
"com.example.FooLocator"
>
  </variable>
 </extension>

In the example above, the variable FOO_HOME is created and the class "com.example.FooLocator" will be used to initialize the value the first time it's requested.


Copyright (c) 2003, 2006 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 https://www.eclipse.org/legal/epl-v10.html


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire