Interface IWorkspaceDescription
ResourcesPlugin class.- See Also:
- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
-
Method Summary
Modifier and TypeMethodDescriptionString[]Returns the order in which projects in the workspace should be built.longReturns the maximum length of time, in milliseconds, a file state should be kept in the local history.intReturns the maximum number of times that the workspace should rebuild when builders affect projects that have already been built.intintReturns the maximum number of states per file that can be stored in the local history.longReturns the maximum permitted size of a file, in bytes, to be stored in the local history.longReturns the interval between automatic workspace snapshots.booleanReturns whether file states are discarded according to the policy specified bysetFileStateLongevity(long),setMaxFileStates(int)andsetMaxFileStateSize(long)methods.booleanReturns whether this workspace performs autobuilds.booleanReturns whether derived files are tracked in the local history.voidsetApplyFileStatePolicy(boolean apply) Sets whether file states are discarded according to the policy specified bysetFileStateLongevity(long),setMaxFileStates(int)andsetMaxFileStateSize(long)methods.voidsetAutoBuilding(boolean value) Records whether this workspace performs autobuilds.voidsetBuildOrder(String[] value) Sets the order in which projects in the workspace should be built.voidsetFileStateLongevity(long time) Sets the maximum time, in milliseconds, a file state should be kept in the local history.voidsetKeepDerivedState(boolean keepDerivedState) Sets whether derived files are tracked in the local history.voidsetMaxBuildIterations(int number) Sets the maximum number of times that the workspace should rebuild when builders affect projects that have already been built.voidsetMaxConcurrentBuilds(int n) Set the max number of builds that can happen concurrently during workspace build.voidsetMaxFileStates(int number) Sets the maximum number of states per file that can be stored in the local history.voidsetMaxFileStateSize(long size) Sets the maximum permitted size of a file, in bytes, to be stored in the local history.voidsetSnapshotInterval(long delay) Sets the interval between automatic workspace snapshots.
-
Method Details
-
getBuildOrder
String[] getBuildOrder()Returns the order in which projects in the workspace should be built. The returned value isnullif the workspace's default build order is being used.- Returns:
- the names of projects in the order they will be built,
or
nullif the default build order should be used - See Also:
-
getFileStateLongevity
long getFileStateLongevity()Returns the maximum length of time, in milliseconds, a file state should be kept in the local history. This setting is ignored by the workspace whenisApplyFileStatePolicy()returnsfalse.- Returns:
- the maximum time a file state should be kept in the local history represented in milliseconds
- See Also:
-
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:
-
getMaxFileStates
int getMaxFileStates()Returns the maximum number of states per file that can be stored in the local history. This setting is ignored by the workspace whenisApplyFileStatePolicy()returnsfalse.- Returns:
- the maximum number of states per file that can be stored in the local history
- See Also:
-
getMaxFileStateSize
long getMaxFileStateSize()Returns the maximum permitted size of a file, in bytes, to be stored in the local history. This setting is ignored by the workspace whenisApplyFileStatePolicy()returnsfalse.- Returns:
- the maximum permitted size of a file to be stored in the local history
- See Also:
-
isKeepDerivedState
boolean isKeepDerivedState()Returns whether derived files are tracked in the local history.- Returns:
trueif local history for derived files is created- Since:
- 3.15
- See Also:
-
isApplyFileStatePolicy
boolean isApplyFileStatePolicy()Returns whether file states are discarded according to the policy specified bysetFileStateLongevity(long),setMaxFileStates(int)andsetMaxFileStateSize(long)methods.- Returns:
trueif file states are removed due to the policy,falseotherwise- Since:
- 3.6
- See Also:
-
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:
-
isAutoBuilding
boolean isAutoBuilding()Returns whether this workspace performs autobuilds.- Returns:
trueif autobuilding is on, otherwisefalse- See Also:
-
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.
Users must call
IWorkspace.setDescriptionbefore changes made to this description take effect.- Parameters:
value-trueto turn on autobuilding, andfalseto turn it off- See Also:
-
setBuildOrder
Sets the order in which projects in the workspace should be built. Projects not named in this list are built in a default order defined by the workspace. Set this value tonullto 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.setDescriptionbefore changes made to this description take effect.- Parameters:
value- the names of projects in the order in which they are built, ornullto use the workspace's default order for all projects- See Also:
-
setFileStateLongevity
void setFileStateLongevity(long time) Sets the maximum time, in milliseconds, a file state should be kept in the local history. This setting is ignored by the workspace whensetApplyFileStatePolicy(boolean)is set to false.Users must call
IWorkspace.setDescriptionbefore changes made to this description take effect.- Parameters:
time- the maximum number of milliseconds a file state should be kept in the local history- See Also:
-
setMaxBuildIterations
void setMaxBuildIterations(int number) Sets the maximum number of times that the workspace should rebuild when builders affect projects that have already been built.Users must call
IWorkspace.setDescriptionbefore changes made to this description take effect.- Parameters:
number- the maximum number of times that the workspace should rebuild when builders affect projects that have already been built.- Since:
- 2.1
- See Also:
-
setMaxFileStates
void setMaxFileStates(int number) Sets the maximum number of states per file that can be stored in the local history. If the maximum number is reached, older states are removed in favor of new ones. This setting is ignored by the workspace whensetApplyFileStatePolicy(boolean)is set tofalse.Users must call
IWorkspace.setDescriptionbefore changes made to this description take effect.- Parameters:
number- the maximum number of states per file that can be stored in the local history- See Also:
-
setMaxFileStateSize
void setMaxFileStateSize(long size) Sets the maximum permitted size of a file, in bytes, to be stored in the local history. This setting is ignored by the workspace whensetApplyFileStatePolicy(boolean)is set tofalse.Users must call
IWorkspace.setDescriptionbefore changes made to this description take effect.- Parameters:
size- the maximum permitted size of a file to be stored in the local history- See Also:
-
setKeepDerivedState
void setKeepDerivedState(boolean keepDerivedState) Sets whether derived files are tracked in the local history.Users must call
IWorkspace.setDescriptionbefore changes made to this description take effect.- Parameters:
keepDerivedState-trueif a history of derived files is needed.- Since:
- 3.15
- See Also:
-
setApplyFileStatePolicy
void setApplyFileStatePolicy(boolean apply) Sets whether file states are discarded according to the policy specified bysetFileStateLongevity(long),setMaxFileStates(int)andsetMaxFileStateSize(long)methods.Users must call
IWorkspace.setDescriptionbefore changes made to this description take effect.- Parameters:
apply-trueif file states are removed due to the policy,falseotherwise- Since:
- 3.6
- See Also:
-
setSnapshotInterval
void setSnapshotInterval(long delay) Sets the interval between automatic workspace snapshots. The new interval will only take effect after the next snapshot.Users must call
IWorkspace.setDescriptionbefore changes made to this description take effect.- Parameters:
delay- the amount of time in milliseconds between automatic workspace snapshots- Since:
- 2.0
- See Also:
-
setMaxConcurrentBuilds
void setMaxConcurrentBuilds(int n) Set the max number of builds that can happen concurrently during workspace build.- Parameters:
n- max number of jobs simultaneously allocated to workspace build. 1 means no job (current thread).- Since:
- 3.13
-
getMaxConcurrentBuilds
int getMaxConcurrentBuilds()- Returns:
- the max number of builds that can happen concurrently during workspace build. 1 means no job (current thread).
- Since:
- 3.13
-