Package 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:
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 Type
    Method
    Description
    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
    getMaxConcurrentBuilds()
     
    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.
    boolean
    isKeepDerivedState()
    Returns whether derived files are tracked in the local history.
    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
    setKeepDerivedState(boolean keepDerivedState)
    Sets whether derived files are tracked 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
    setMaxConcurrentBuilds(int n)
    Set the max number of builds that can happen concurrently during workspace build.
    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.