Eclipse Plug-in Developer Guide (Galileo) - IWorkspaceDescription (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.core.resources
Interface IWorkspaceDescription

public interface IWorkspaceDescription

A workspace description represents the workspace preferences. It can be used to query the current preferences and set new ones. The workspace preference values are stored in the preference store and are also accessible via the preference mechanism. Constants for the preference keys are found on the ResourcesPlugin class.

See Also:: IWorkspace.getDescription(), IWorkspace.setDescription(IWorkspaceDescription), IWorkspace.newProjectDescription(String)
Restriction:: This interface is not intended to be implemented by clients.
Restriction:: This interface is not intended to be extended by clients.

Method Summary

String[] getBuildOrder ()
          Returns the order in which projects in the workspace should be built.

long getFileStateLongevity ()
          Returns the maximum length of time, in milliseconds, a file state should be kept in the local history.

int getMaxBuildIterations ()
          Returns the maximum number of times that the workspace should rebuild when builders affect projects that have already been built.

int getMaxFileStates ()
          Returns the maximum number of states per file that can be stored in the local history.

long getMaxFileStateSize ()
          Returns the maximum permitted size of a file, in bytes, to be stored in the local history.

long getSnapshotInterval ()
          Returns the interval between automatic workspace snapshots.

boolean isAutoBuilding ()
          Returns whether this workspace performs autobuilds.

void setAutoBuilding (boolean value)
          Records whether this workspace performs autobuilds.

void setBuildOrder ( String[] value)
          Sets the order in which projects in the workspace should be built.

void setFileStateLongevity (long time)
          Sets the maximum time, in milliseconds, a file state should be kept in the local history.

void setMaxBuildIterations (int number)
          Sets the maximum number of times that the workspace should rebuild when builders affect projects that have already been built.

void setMaxFileStates (int number)
          Sets the maximum number of states per file that can be stored in the local history.

void setMaxFileStateSize (long size)
          Sets the maximum permitted size of a file, in bytes, to be stored in the local history.

void setSnapshotInterval (long delay)
          Sets the interval between automatic workspace snapshots.

Method Detail

getBuildOrder


String[] getBuildOrder()

Returns the order in which projects in the workspace should be built. The returned value is null if the workspace's default build order is being used.

Returns:: the names of projects in the order they will be built, or null if the default build order should be used
See Also:: setBuildOrder(String[]), ResourcesPlugin.PREF_BUILD_ORDER

getFileStateLongevity

long getFileStateLongevity()

Returns the maximum length of time, in milliseconds, a file state should be kept in the local history.

Returns:: the maximum time a file state should be kept in the local history represented in milliseconds
See Also:: setFileStateLongevity(long), ResourcesPlugin.PREF_FILE_STATE_LONGEVITY

getMaxBuildIterations

int getMaxBuildIterations()

Returns the maximum number of times that the workspace should rebuild when builders affect projects that have already been built.

Returns:: the maximum number of times that the workspace should rebuild when builders affect projects that have already been built.
Since:: 2.1
See Also:: setMaxBuildIterations(int), ResourcesPlugin.PREF_MAX_BUILD_ITERATIONS

getMaxFileStates

int getMaxFileStates()

Returns the maximum number of states per file that can be stored in the local history.

Returns:: the maximum number of states per file that can be stored in the local history
See Also:: setMaxFileStates(int), ResourcesPlugin.PREF_MAX_FILE_STATES

getMaxFileStateSize

long getMaxFileStateSize()

Returns the maximum permitted size of a file, in bytes, to be stored in the local history.

Returns:: the maximum permitted size of a file to be stored in the local history
See Also:: setMaxFileStateSize(long), ResourcesPlugin.PREF_MAX_FILE_STATE_SIZE

getSnapshotInterval

long getSnapshotInterval()

Returns the interval between automatic workspace snapshots.

Returns:: the amount of time in milliseconds between automatic workspace snapshots
Since:: 2.0
See Also:: setSnapshotInterval(long), ResourcesPlugin.PREF_SNAPSHOT_INTERVAL

isAutoBuilding

boolean isAutoBuilding()

Returns whether this workspace performs autobuilds.

Returns:: true if autobuilding is on, otherwise false
See Also:: setAutoBuilding(boolean), ResourcesPlugin.PREF_AUTO_BUILDING

setAutoBuilding

void setAutoBuilding(boolean value)

Records whether this workspace performs autobuilds.

When autobuild is on, any changes made to a project and its resources automatically triggers an incremental build of the workspace.