oracle.ide.model

Class SharedPropertiesManager

java.lang.Object

oracle.ide.model.SharedPropertiesManager

public abstract class SharedPropertiesManager
extends java.lang.Object

Class that works with project properties that can be stored at the workspace level and shared across projects in that Workspace.

Since:

12.1.3

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SharedPropertiesManager()

Method Summary

Methods

Modifier and Type	Method and Description
static SharedPropertiesManager	get() Gets the SharedPropertiesManager.
abstract PropertyStorage	getPropertyStorage(Project project, java.lang.String propertyDataKey) Returns a PropertyStorage object that wraps either the workspace shared properties or the project properties, depending on where the properties identified by propertyDataKey are stored.
abstract PropertyStorage	getPropertyStorage(Project project, Workspace parentWorkspace, java.lang.String propertyDataKey) Returns a PropertyStorage object that wraps either the workspace shared properties or the project properties, depending on where the properties identified by propertyDataKey are stored.
abstract boolean	isUsingSharedProperties(Project project, java.lang.String propertyDataKey) Indicates whether the supplied project is getting the properties identified by propertyDataKey from the Workspace or from the Project.
abstract boolean	propertiesAreShareable(java.lang.String propertyDataKey) Indicates whether the properties identified by propertyDataKey have been registered to be shared at the Workspace level.
abstract void	setUsesSharedProperties(Project project, java.lang.String propertyDataKey, boolean usesShared) Controls whether or not the supplied project gets the properties identified by propertyDataKey from the Workspace or from the Project.

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedPropertiesManager

protected SharedPropertiesManager()

Method Detail

get

public static SharedPropertiesManager get()

Gets the SharedPropertiesManager.

getPropertyStorage

public abstract PropertyStorage getPropertyStorage(Project project,
                                 java.lang.String propertyDataKey)

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

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

Parameters:

project - the Project whose properties are being retrieved

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

Returns:

a PropertyStorage object

Throws:

java.lang.IllegalStateException - if Project.getWorkspace() returns null

See Also:

getPropertyStorage(Project, Workspace, String)

getPropertyStorage

public abstract PropertyStorage getPropertyStorage(Project project,
                                 Workspace parentWorkspace,
                                 java.lang.String propertyDataKey)

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

Parameters:

project - the Project whose properties are being retrieved

parentWorkspace - the Project's owning Workspace

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

Returns:

a PropertyStorage object

See Also:

getPropertyStorage(Project, String)

propertiesAreShareable

public abstract boolean propertiesAreShareable(java.lang.String propertyDataKey)

Indicates whether the properties identified by propertyDataKey have been registered to be shared at the Workspace level.

Parameters:

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

Returns:

true if the properties are registered as shareable, false otherwise

isUsingSharedProperties

public abstract boolean isUsingSharedProperties(Project project,
                              java.lang.String propertyDataKey)

Indicates whether the supplied project is getting the properties identified by propertyDataKey from the Workspace or from the Project.

Parameters:

project - the Project whose properties are being retrieved

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

Returns:

true if the properties in use are those stored in the workspace, false otherwise

setUsesSharedProperties

public abstract void setUsesSharedProperties(Project project,
                           java.lang.String propertyDataKey,
                           boolean usesShared)

Controls whether or not the supplied project gets the properties identified by propertyDataKey from the Workspace or from the Project.

Parameters:

project - the Project whose properties are being retrieved

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

usesShared - if true, if the properties are inherited from the workspace; otherwise the properpties are not inherited