|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
IWorkspace.getDescription()
,
IWorkspace.setDescription(IWorkspaceDescription)
,
IWorkspace.newProjectDescription(String)
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 |
isApplyFileStatePolicy()
Returns whether file states are discarded according to the policy specified by setFileStateLongevity(long) , setMaxFileStates(int)
and setMaxFileStateSize(long) methods. |
boolean |
isAutoBuilding()
Returns whether this workspace performs autobuilds. |
void |
setApplyFileStatePolicy(boolean apply)
Sets whether file states are discarded according to the policy specified by setFileStateLongevity(long) , setMaxFileStates(int)
and setMaxFileStateSize(long) methods. |
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 |
---|
String[] getBuildOrder()
null
if the workspace's default build
order is being used.
null
if the default build order should be usedsetBuildOrder(String[])
,
ResourcesPlugin.PREF_BUILD_ORDER
long getFileStateLongevity()
isApplyFileStatePolicy()
returns false
.
setFileStateLongevity(long)
,
isApplyFileStatePolicy()
,
ResourcesPlugin.PREF_FILE_STATE_LONGEVITY
int getMaxBuildIterations()
setMaxBuildIterations(int)
,
ResourcesPlugin.PREF_MAX_BUILD_ITERATIONS
int getMaxFileStates()
isApplyFileStatePolicy()
returns false
.
setMaxFileStates(int)
,
isApplyFileStatePolicy()
,
ResourcesPlugin.PREF_MAX_FILE_STATES
long getMaxFileStateSize()
isApplyFileStatePolicy()
returns false
.
setMaxFileStateSize(long)
,
isApplyFileStatePolicy()
,
ResourcesPlugin.PREF_MAX_FILE_STATE_SIZE
boolean isApplyFileStatePolicy()
setFileStateLongevity(long)
, setMaxFileStates(int)
and setMaxFileStateSize(long)
methods.
true
if file states are removed due to the policy,
false
otherwisesetApplyFileStatePolicy(boolean)
,
setFileStateLongevity(long)
,
setMaxFileStates(int)
,
setMaxFileStateSize(long)
,
ResourcesPlugin.PREF_APPLY_FILE_STATE_POLICY
long getSnapshotInterval()
setSnapshotInterval(long)
,
ResourcesPlugin.PREF_SNAPSHOT_INTERVAL
boolean isAutoBuilding()
true
if autobuilding is on, otherwise
false
setAutoBuilding(boolean)
,
ResourcesPlugin.PREF_AUTO_BUILDING
void setAutoBuilding(boolean value)
When autobuild is on, any changes made to a project and its resources automatically triggers an incremental build of the workspace.
Users must call IWorkspace.setDescription
before changes
made to this description take effect.
value
- true
to turn on autobuilding,
and false
to turn it offIWorkspace.setDescription(IWorkspaceDescription)
,
isAutoBuilding()
,
ResourcesPlugin.PREF_AUTO_BUILDING
void setBuildOrder(String[] value)
null
to use the
default ordering for all projects. Projects not named in the list are
built in unspecified order after all ordered projects.
Users must call IWorkspace.setDescription
before changes
made to this description take effect.
value
- the names of projects in the order in which they are built,
or null
to use the workspace's default order for all projectsIWorkspace.setDescription(IWorkspaceDescription)
,
getBuildOrder()
,
ResourcesPlugin.PREF_BUILD_ORDER
void setFileStateLongevity(long time)
setApplyFileStatePolicy(boolean)
is set to false.
Users must call IWorkspace.setDescription
before changes
made to this description take effect.
time
- the maximum number of milliseconds a file state should be
kept in the local historyIWorkspace.setDescription(IWorkspaceDescription)
,
getFileStateLongevity()
,
setApplyFileStatePolicy(boolean)
,
ResourcesPlugin.PREF_FILE_STATE_LONGEVITY
void setMaxBuildIterations(int number)
Users must call IWorkspace.setDescription
before changes
made to this description take effect.
number
- the maximum number of times that the workspace should rebuild
when builders affect projects that have already been built.IWorkspace.setDescription(IWorkspaceDescription)
,
getMaxBuildIterations()
,
ResourcesPlugin.PREF_MAX_BUILD_ITERATIONS
void setMaxFileStates(int number)
setApplyFileStatePolicy(boolean)
is set to false
.
Users must call IWorkspace.setDescription
before changes
made to this description take effect.
number
- the maximum number of states per file that can be stored in the local historyIWorkspace.setDescription(IWorkspaceDescription)
,
getMaxFileStates()
,
setApplyFileStatePolicy(boolean)
,
ResourcesPlugin.PREF_MAX_FILE_STATES
void setMaxFileStateSize(long size)
setApplyFileStatePolicy(boolean)
is set to false
.
Users must call IWorkspace.setDescription
before changes
made to this description take effect.
size
- the maximum permitted size of a file to be stored in the local historyIWorkspace.setDescription(IWorkspaceDescription)
,
getMaxFileStateSize()
,
setApplyFileStatePolicy(boolean)
,
ResourcesPlugin.PREF_MAX_FILE_STATE_SIZE
void setApplyFileStatePolicy(boolean apply)
setFileStateLongevity(long)
, setMaxFileStates(int)
and setMaxFileStateSize(long)
methods.
Users must call IWorkspace.setDescription
before changes
made to this description take effect.
apply
- true
if file states are removed due to the policy,
false
otherwiseIWorkspace.setDescription(IWorkspaceDescription)
,
setFileStateLongevity(long)
,
setMaxFileStates(int)
,
setMaxFileStateSize(long)
,
isApplyFileStatePolicy()
,
ResourcesPlugin.PREF_APPLY_FILE_STATE_POLICY
void setSnapshotInterval(long delay)
Users must call IWorkspace.setDescription
before changes
made to this description take effect.
delay
- the amount of time in milliseconds between automatic workspace snapshotsIWorkspace.setDescription(IWorkspaceDescription)
,
getSnapshotInterval()
,
ResourcesPlugin.PREF_SNAPSHOT_INTERVAL
|
Eclipse Platform Release 3.6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.