Method Detail

• public long getTotalNumberOfUnsavedProperties()

  It is used for analytics and returns the number of properties marked as locally stored in the current workspace.

  Returns:

  the number of properties.

• public java.lang.String getUserSpecificValue(Project project, ModelItem modelItem, java.lang.String name)

  Gets the overridden value of the property identified by the project, model item, and name.

  Parameters:

  project - the parent project of the model item

  modelItem - the owner of the property

  name - the property name

  Returns:

  the overridden value of the property, null if the value is not found

• public static UserSpecificProperties instance()

• public static boolean isApplicableFor(ModelItem modelItem)

  This is the common way to check if the model item supports property value overriding.

  Parameters:

  modelItem - the model item to check.

  Returns:

  true if it supports overriding.

• @net.engio.mbassy.listener.Handler @java.lang.SuppressWarnings("unused") public void modelItemDeleted(ModelItemDeletionMessage deletionMessage)

• @net.engio.mbassy.listener.Handler @java.lang.SuppressWarnings("unused") public void projectRemoved(ProjectRemovedMessage deletionMessage)

• public void removeUserSpecificValue(Project project, ModelItem modelItem, java.lang.String name)

  Removes the overridden value from the storage. The value is identified by the project, modelItem, and name.

  Parameters:

  project - the parent project of the model item

  modelItem - the owner of the property

  name - the property name

• public void saveCurrentStateToConfig()

  Saves the current values of the overridden properties of all supported model items. The config object the values are saved to has been set by the @setOverridenPropertyValuesConfig<Project> method.

• public void sayPropertyIsPresent(Project project, ModelItem modelItem, java.lang.String name, java.lang.String defaultValue)

  The obsolete values (of model items which are not present in the workspace any more) must be removed. So, we need to know, which properties in each workspace project are marked as locally stored to remove the others. Walking through the whole navigator tree and through all properties takes a lot of time. Each supported model item uses a specific class XmlBeansUserSpecificTestPropertyHolder. The class adds the code which enumerates locally stored properties calling this method.

  The optimization is based on the idea that unsupported model items do not enumerate their own properties to store values locally and do not have any check for support. We can say that they are already marked with a specific code of a specific class at compile time.

  Parameters:

  project - the parent of the model item which is the property owner

  modelItem - the property owner

  name - the property name

  defaultValue - the value from the project file

• public void setOverridenPropertyValuesConfig(OverridenPropertyValuesConfig overridenPropertyValuesConfig, java.util.List<Project> projectList)

  Sets the config object of the property value storage, then loads the values from the storage as the current values.

  Parameters:

  overridenPropertyValuesConfig - the config object to load values from.

• public void setUserSpecificValue(Project project, ModelItem modelItem, java.lang.String name, java.lang.String value)

  Adds or replaces the overridden value of the property identified by the project, model item, and name.

  Parameters:

  project - the parent project of the model item

  modelItem - the owner of the property

  name - the property name