oracle.ide.model

Class SharedPropertiesAdapter

java.lang.Object

oracle.javatools.data.HashStructureAdapter

oracle.ide.model.SharedPropertiesAdapter

Direct Known Subclasses:

RunConfiguration, RunConfigurations

public class SharedPropertiesAdapter
extends HashStructureAdapter

Class that handles project properties that are registered as shareable and are stored in the Workspace to be shared across projects.

Subclasses should use getActivePropertyStorage(oracle.ide.model.Project, java.lang.String) to get the active PropertyStorage object for their properties, either those stored in the Project or in the Workspace.

Since:

12.1.3

Field Summary

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Constructor Summary

Constructors

Constructor and Description
SharedPropertiesAdapter(HashStructure hashStructure)

Method Summary

Modifier and Type	Method and Description
protected static PropertyStorage	getActivePropertyStorage(Project project, java.lang.String dataKey) Returns a PropertyStorage object that wraps either the workspace shared properties or the project properties, depending on where the properties identified by dataKey are stored.
protected static PropertyStorage	getActivePropertyStorage(Project project, Workspace workspace, java.lang.String dataKey) Returns a PropertyStorage object that wraps either the workspace shared properties or the project properties, depending on where the properties identified by dataKeyare stored.

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

Constructor Detail

SharedPropertiesAdapter

public SharedPropertiesAdapter(HashStructure hashStructure)

Method Detail

getActivePropertyStorage

protected static final PropertyStorage getActivePropertyStorage(Project project,
                                                                java.lang.String dataKey)

Returns a PropertyStorage object that wraps either the workspace shared properties or the project properties, depending on where the properties identified by dataKey are stored.

Note: This method will throw an NullPointerException if Project.getWorkspace() returns null, which happens if the supplied project is a copy of the original project. In that case use getActivePropertyStorage(Project, Workspace, String) instead.

Parameters:

project - the Project whose properties are being retrieved

dataKey - the key to the root HashStructure for your properties data

Returns:

a PropertyStorage data object

Throws:

java.lang.IllegalStateException - if dataKey has not been registered as shareable or if Project.getWorkspace() returns null

java.lang.NullPointerException - if any of the parameters are null

See Also:

getActivePropertyStorage(Project, Workspace, String), SharedPropertiesManager.isUsingSharedProperties(Project, String)

getActivePropertyStorage

protected static final PropertyStorage getActivePropertyStorage(Project project,
                                                                Workspace workspace,
                                                                java.lang.String dataKey)

Returns a PropertyStorage object that wraps either the workspace shared properties or the project properties, depending on where the properties identified by dataKeyare stored.

Parameters:

project - the Project whose properties are being retrieved; must not be null

workspace - the Project's owning workspace; must not be null

dataKey - the key to the root HashStructure for your properties data

Returns:

a PropertyStorage data object

Throws:

java.lang.IllegalStateException - if dataKey has not been registered as shareable

java.lang.NullPointerException - if any of the parameters are null