oracle.ide.model

Class WorkingSets

java.lang.Object

oracle.javatools.data.HashStructureAdapter

oracle.ide.model.WorkingSets

public class WorkingSets
extends HashStructureAdapter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADD_TO_WORKING_SET_CMD The action id for the add to working set command.
static int	ADD_TO_WORKING_SET_CMD_ID Deprecated. since 11.0 use Ide#findOrCreateCmdID( ADD_TO_WORKING_SET_CMD ).
static java.lang.String	ADD_TO_WORKING_SET_MSG_KEY Deprecated. this identifier is no longer used
static java.lang.String	ALL_FILES_WORKING_SET_LABEL The label to use for the non-editable, all-files working set.
static java.lang.String	DATA_KEY The key used to identify working sets in a hash structure.
static java.lang.String	DEFAULT_WORKING_SET_LABEL Deprecated. The default working set is no longer created automatically, as of 12.0.
static boolean	ENABLED Deprecated. since 11.0

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Method Summary

Modifier and Type	Method and Description
void	deleteWorkingSet(java.lang.String workingSetName)
WorkingSet	getCurrentWorkingSet()
java.lang.String	getCurrentWorkingSetName()
static WorkingSets	getInstance(Project project) Deprecated. Since 11.0. Working sets are now stored at the application level, not at the project level, so use getInstance(Workspace).
static WorkingSets	getInstance(Workspace workspace) Gets the WorkingSets object for this supplied Workpsace.
static WorkingSet	getOrCreateWorkingSet(Workspace workspace, java.lang.String name, java.util.List<Project> includeProjects, java.util.Map<java.net.URL,java.util.List<java.net.URL>> projectUrlToFileUrls) Gets or creates a working set with the name given.
WorkingSet	getWorkingSet(java.lang.String workingSetName) Gets or creates a working set with the supplied name.
java.util.List	getWorkingSetNames() Gets a list of names of all working sets.
static java.util.Set<java.net.URL>	projectUrls(Workspace workspace)
void	setCurrentWorkingSetName(java.lang.String name) Sets the active working set.
static boolean	validateName(java.lang.String workingSetName) Checks the supplied name to ensure it is a valid working set name.

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENABLED

@Deprecated
public static final boolean ENABLED

Deprecated. since 11.0

ADD_TO_WORKING_SET_CMD

public static final java.lang.String ADD_TO_WORKING_SET_CMD

The action id for the add to working set command.

Since:

11.0

See Also:

Constant Field Values

ADD_TO_WORKING_SET_CMD_ID

@Deprecated
public static int ADD_TO_WORKING_SET_CMD_ID

Deprecated. since 11.0 use Ide#findOrCreateCmdID( ADD_TO_WORKING_SET_CMD ).

ADD_TO_WORKING_SET_MSG_KEY

@Deprecated
public static final java.lang.String ADD_TO_WORKING_SET_MSG_KEY

Deprecated. this identifier is no longer used

Key for storing the preference for the Add to Working Set optional message.

See Also:

Constant Field Values

DEFAULT_WORKING_SET_LABEL

@Deprecated
public static final java.lang.String DEFAULT_WORKING_SET_LABEL

Deprecated. The default working set is no longer created automatically, as of 12.0.

The label to use for the default, editable working set.

ALL_FILES_WORKING_SET_LABEL

public static final java.lang.String ALL_FILES_WORKING_SET_LABEL

The label to use for the non-editable, all-files working set.

DATA_KEY

public static final java.lang.String DATA_KEY

The key used to identify working sets in a hash structure.

See Also:

Constant Field Values

Method Detail

getInstance

@Deprecated
public static WorkingSets getInstance(Project project)

Deprecated. Since 11.0. Working sets are now stored at the application level, not at the project level, so use getInstance(Workspace).

getInstance

public static WorkingSets getInstance(Workspace workspace)

Gets the WorkingSets object for this supplied Workpsace.

Parameters:

workspace - a Workspace; should not be null

Returns:

a WorkingSets object

getWorkingSet

public WorkingSet getWorkingSet(java.lang.String workingSetName)

Gets or creates a working set with the supplied name. The name should not be null or an empty string. The name should not contain forward or backward slash characters. To ensure the name is valid, call validateName(java.lang.String) before calling this method.

Parameters:

workingSetName - the working set name

Returns:

a WorkingSet

See Also:

validateName(java.lang.String)

validateName

public static boolean validateName(java.lang.String workingSetName)

Checks the supplied name to ensure it is a valid working set name. The name "(All Files)" is reserved and cannot be used. The name must be non-null, must not be an empty string, and should not contain forward or backward slash characters.

getOrCreateWorkingSet

public static WorkingSet getOrCreateWorkingSet(Workspace workspace,
                                               java.lang.String name,
                                               java.util.List<Project> includeProjects,
                                               java.util.Map<java.net.URL,java.util.List<java.net.URL>> projectUrlToFileUrls)

Gets or creates a working set with the name given. The name must be non-null, must not be an empty string, and should not contain forward or backward slash characters. To ensure the name is valid, call validateName(java.lang.String) before calling this method.

The latter parameters describe the projects to include in the working set and, for each project, the set of URLs to include. If a working set with the supplied name already exists, it will be overwritten by the new one.

Parameters:

workspace - the workspace in which to create the new WorkingSet

name - the working set name

includeProjects - the list of Projects to include in the working set

projectUrlToFileUrls - the projects and files to include (show)

Returns:

a new working set

Throws:

java.lang.NullPointerException - if name or data is null, or if any of the objects in data are null

See Also:

validateName(java.lang.String)

projectUrls

public static java.util.Set<java.net.URL> projectUrls(Workspace workspace)

getCurrentWorkingSetName

public java.lang.String getCurrentWorkingSetName()

setCurrentWorkingSetName

public void setCurrentWorkingSetName(java.lang.String name)

Sets the active working set. The name must not be null.

Parameters:

name - the working set name

Throws:

java.lang.NullPointerException - if the name is null

getCurrentWorkingSet

public WorkingSet getCurrentWorkingSet()

getWorkingSetNames

public java.util.List getWorkingSetNames()

Gets a list of names of all working sets.

Returns:

a list of Strings

deleteWorkingSet

public void deleteWorkingSet(java.lang.String workingSetName)