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.

This interface is not intended to be implemented by clients.

See Also:

IWorkspace.getDescription(), IWorkspace.setDescription(org.eclipse.core.resources.IWorkspaceDescription)

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	getMaxFileStates() Returns the maximum number of states per file that can be stored in the local history.
long	getMaxFileStateSize() Returns the maximum permited 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 auto-builds.
void	setAutoBuilding(boolean value) Records whether this workspace performs auto-builds.
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	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 permited 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

public 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(java.lang.String[])

getFileStateLongevity

public 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)

getMaxFileStates

public 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)

getMaxFileStateSize

public long getMaxFileStateSize()

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

Returns:

the maximum permited size of a file to be stored in the local history

See Also:

setMaxFileStateSize(long)

getSnapshotInterval

public 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)

isAutoBuilding

public boolean isAutoBuilding()

Returns whether this workspace performs auto-builds.

Returns:

true if auto-building is on, otherwise false

See Also:

setAutoBuilding(boolean)

setAutoBuilding

public void setAutoBuilding(boolean value)

Records whether this workspace performs auto-builds.

When auto-build is on, any changes made to a project and its resources automatically triggers an incremental build of that project. If resources in several projects are changed within the scope of a workspace runnable, the affected projects are auto-built in no particular order.

Users must call IWorkspace.setDescription before changes made to this description take effect.

Parameters:

value - true to turn on auto-building, and false to turn it off

See Also:

IWorkspace.setDescription(org.eclipse.core.resources.IWorkspaceDescription), isAutoBuilding()

setBuildOrder

public void setBuildOrder(String[] value)

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 to 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.

Parameters:

value - the names of projects in the order in which they are built, or null to use the workspace's default order for all projects

See Also:

IWorkspace.setDescription(org.eclipse.core.resources.IWorkspaceDescription), getBuildOrder()

setFileStateLongevity

public void setFileStateLongevity(long time)

Sets the maximum time, in milliseconds, a file state should be kept in the local history.

Users must call IWorkspace.setDescription before 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:

IWorkspace.setDescription(org.eclipse.core.resources.IWorkspaceDescription), getFileStateLongevity()

setMaxFileStates

public 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.

Users must call IWorkspace.setDescription before 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:

IWorkspace.setDescription(org.eclipse.core.resources.IWorkspaceDescription), getMaxFileStates()

setMaxFileStateSize

public void setMaxFileStateSize(long size)

Sets the maximum permited size of a file, in bytes, to be stored in the local history.

Users must call IWorkspace.setDescription before changes made to this description take effect.

Parameters:

size - the maximum permited size of a file to be stored in the local history

See Also:

IWorkspace.setDescription(org.eclipse.core.resources.IWorkspaceDescription), getMaxFileStateSize()

setSnapshotInterval

public 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.setDescription before changes made to this description take effect.

Parameters:

delay - the amount of time in milliseconds between automatic workspace snapshots

Since:

2.0

See Also:

IWorkspace.setDescription(org.eclipse.core.resources.IWorkspaceDescription), getSnapshotInterval()