|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.runtime.Plugin
org.eclipse.core.resources.ResourcesPlugin
The plug-in runtime class for the Resources plug-in. This is
the starting point for all workspace and resource manipulation.
A typical sequence of events would be for a dependent plug-in
to call ResourcesPlugin.getWorkspace()
.
Doing so would cause this plug-in to be activated and the workspace
(if any) to be loaded from disk and initialized.
Field Summary | |
static Object |
FAMILY_AUTO_BUILD
Constant identifying the job family identifier for the background autobuild job. |
static Object |
FAMILY_MANUAL_BUILD
Constant identifying the job family identifier for a background build job. |
static String |
PI_RESOURCES
Unique identifier constant (value "org.eclipse.core.resources" )
for the standard Resources plug-in. |
static String |
PREF_AUTO_BUILDING
Name of a preference for configuring whether the workspace performs auto- builds. |
static String |
PREF_AUTO_REFRESH
Name of a preference for configuring whether the workspace performs auto- refresh. |
static String |
PREF_BUILD_ORDER
Name of a preference for configuring the order projects in the workspace are built. |
static String |
PREF_DEFAULT_BUILD_ORDER
Name of a preference for configuring whether to use the workspace's default order for building projects. |
static String |
PREF_DISABLE_LINKING
Name of a preference for turning off support for linked resources. |
static String |
PREF_ENCODING
Name of a preference indicating the encoding to use when reading text files in the workspace. |
static String |
PREF_FILE_STATE_LONGEVITY
Name of a preference for configuring the maximum number of milliseconds a file state should be kept in the local history |
static String |
PREF_MAX_BUILD_ITERATIONS
Name of a preference for configuring the maximum number of times that the workspace should rebuild when builders affect projects that have already been built. |
static String |
PREF_MAX_FILE_STATE_SIZE
Name of a preference for configuring the maximum permited size of a file to be stored in the local history |
static String |
PREF_MAX_FILE_STATES
Name of a preference for configuring the maximum number of states per file that can be stored in the local history. |
static String |
PREF_MAX_NOTIFICATION_DELAY
Name of a preference for configuring the maximum amount of time in millseconds between a workspace change and the subsequent resource change notification. |
static String |
PREF_SNAPSHOT_INTERVAL
Name of a preference for configuring the amount of time in milliseconds between automatic workspace snapshots |
static String |
PT_BUILDERS
Simple identifier constant (value "builders" )
for the builders extension point. |
static String |
PT_FILE_MODIFICATION_VALIDATOR
Simple identifier constant (value "fileModificationValidator" )
for the file modification validator extension point. |
static String |
PT_MARKERS
Simple identifier constant (value "markers" )
for the markers extension point. |
static String |
PT_MOVE_DELETE_HOOK
Simple identifier constant (value "moveDeleteHook" )
for the move/delete hook extension point. |
static String |
PT_NATURES
Simple identifier constant (value "natures" )
for the natures extension point. |
static String |
PT_REFRESH_PROVIDERS
Simple identifier constant (value "refreshProviders" )
for the auto-refresh refresh providers extension point. |
static String |
PT_TEAM_HOOK
Simple identifier constant (value "teamHook" )
for the team hook extension point. |
Fields inherited from class org.eclipse.core.runtime.Plugin |
PLUGIN_PREFERENCE_SCOPE, PREFERENCES_DEFAULT_OVERRIDE_BASE_NAME, PREFERENCES_DEFAULT_OVERRIDE_FILE_NAME |
Constructor Summary | |
ResourcesPlugin(IPluginDescriptor pluginDescriptor)
Constructs an instance of this plug-in runtime class. |
Method Summary | |
static String |
getEncoding()
Returns the encoding to use when reading text files in the workspace. |
static ResourcesPlugin |
getPlugin()
Returns the Resources plug-in. |
static IWorkspace |
getWorkspace()
Returns the workspace. |
void |
shutdown()
This implementation of the corresponding Plugin method
closes the workspace (without saving). |
void |
startup()
This implementation of the corresponding Plugin method
opens the workspace. |
Methods inherited from class org.eclipse.core.runtime.Plugin |
find, find, getBundle, getDescriptor, getLog, getPluginPreferences, getStateLocation, initializeDefaultPluginPreferences, internalInitializeDefaultPluginPreferences, isDebugging, openStream, openStream, savePluginPreferences, setDebugging, start, stop, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String PI_RESOURCES
"org.eclipse.core.resources"
)
for the standard Resources plug-in.
public static final String PT_BUILDERS
"builders"
)
for the builders extension point.
public static final String PT_NATURES
"natures"
)
for the natures extension point.
public static final String PT_MARKERS
"markers"
)
for the markers extension point.
public static final String PT_FILE_MODIFICATION_VALIDATOR
"fileModificationValidator"
)
for the file modification validator extension point.
public static final String PT_MOVE_DELETE_HOOK
"moveDeleteHook"
)
for the move/delete hook extension point.
public static final String PT_TEAM_HOOK
"teamHook"
)
for the team hook extension point.
public static final String PT_REFRESH_PROVIDERS
"refreshProviders"
)
for the auto-refresh refresh providers extension point.
public static final Object FAMILY_AUTO_BUILD
IJobManager.join(Object, IProgressMonitor)
public static final Object FAMILY_MANUAL_BUILD
belongsTo
.
IJobManager.join(Object, IProgressMonitor)
,
Job.belongsTo(Object)
public static final String PREF_ENCODING
System.getProperty("file.encoding")
.
There is also a convenience method getEncoding
which returns
the value of this preference, or the file system encoding if this
preference is not set.
Note that there is no guarantee that the value is a supported encoding.
Callers should be prepared to handle UnsupportedEncodingException
where this encoding is used.
getEncoding()
,
UnsupportedEncodingException
,
Constant Field Valuespublic static final String PREF_MAX_NOTIFICATION_DELAY
public static final String PREF_AUTO_BUILDING
IWorkspaceDescription.isAutoBuilding()
,
IWorkspaceDescription.setAutoBuilding(boolean)
,
Constant Field Valuespublic static final String PREF_BUILD_ORDER
IWorkspaceDescription.getBuildOrder()
,
IWorkspaceDescription.setBuildOrder(String[])
,
Constant Field Valuespublic static final String PREF_DEFAULT_BUILD_ORDER
public static final String PREF_MAX_BUILD_ITERATIONS
IWorkspaceDescription.getMaxBuildIterations()
,
IWorkspaceDescription.setMaxBuildIterations(int)
,
Constant Field Valuespublic static final String PREF_FILE_STATE_LONGEVITY
IWorkspaceDescription.getFileStateLongevity()
,
IWorkspaceDescription.setFileStateLongevity(long)
,
Constant Field Valuespublic static final String PREF_MAX_FILE_STATE_SIZE
IWorkspaceDescription.getMaxFileStateSize()
,
IWorkspaceDescription.setMaxFileStateSize(long)
,
Constant Field Valuespublic static final String PREF_MAX_FILE_STATES
IWorkspaceDescription.getMaxFileStates()
,
IWorkspaceDescription.setMaxFileStates(int)
,
Constant Field Valuespublic static final String PREF_SNAPSHOT_INTERVAL
IWorkspaceDescription.getSnapshotInterval()
,
IWorkspaceDescription.setSnapshotInterval(long)
,
Constant Field Valuespublic static final String PREF_DISABLE_LINKING
public static final String PREF_AUTO_REFRESH
Constructor Detail |
public ResourcesPlugin(IPluginDescriptor pluginDescriptor)
An instance of this plug-in runtime class is automatically created when the facilities provided by the Resources plug-in are required. Clients must never explicitly instantiate a plug-in runtime class.
pluginDescriptor
- the plug-in descriptor for the
Resources plug-inMethod Detail |
public static String getEncoding()
PREF_ENCODING
preference, or the
file system encoding (System.getProperty("file.encoding")
)
if the preference is not set.
Note that this method does not check whether the result is a supported
encoding. Callers should be prepared to handle
UnsupportedEncodingException
where this encoding is used.
UnsupportedEncodingException
public static ResourcesPlugin getPlugin()
public static IWorkspace getWorkspace()
null
if this plug-in has been shut down.public void shutdown() throws CoreException
Plugin
method
closes the workspace (without saving).
shutdown
in class Plugin
CoreException
- if this method fails to shut down
this plug-inPlugin.shutdown()
public void startup() throws CoreException
Plugin
method
opens the workspace.
startup
in class Plugin
CoreException
- if this plug-in did not start up properlyPlugin.startup()
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.