Interface IProjectCheckMetadataManager
- All Known Implementing Classes:
ProjectCheckMetadataManager
public interface IProjectCheckMetadataManager
This manager handles the processing of existing check registration, finding any updates (via bundle changes) and
persist this metainformation to be able to find new/updates checks during next changes. The information is processed
and stored on per-project basic in order to support hibernation of projects with proper continuation of check
operations after they are back online
-
Method Summary
Modifier and TypeMethodDescriptionGet the check using its unique identifiergetChecksForCheckId
(String checkId) Gets the check using its natural identifier.getShortUid
(CheckUid checkUid) Gets the short UID for the givenCheckUid
in the context of the corresponding projectgetUidForCheckId
(String checkId) Gets the set of check unique identifiers for the given natural check identifier.getUidForShortUid
(String shortUid) Gets the check unique identifier for the given short UIDvoid
Persists current check metadata to the persistent store
-
Method Details
-
getCheck
Get the check using its unique identifier- Parameters:
checkId
- The identifier of the check. May not benull
- Returns:
- The check, if present. May be
null
-
getChecksForCheckId
Gets the check using its natural identifier. In case if several bundles supply checks with the same identifier, this method could return more than one check- Parameters:
checkId
- The identifier of the check. May benull
, in which case checks for all registered check IDs are returned.- Returns:
- Checks mapped to their unique identifiers. May not be
null
-
getShortUid
Gets the short UID for the givenCheckUid
in the context of the corresponding project- Parameters:
checkUid
- The target check UID. May not benull
- Returns:
- The short UID of the check. May be
null
if the given CheckUID isn't registered
-
getUidForCheckId
Gets the set of check unique identifiers for the given natural check identifier. In case if several bundles supply checks with the same identifier, this method could return more than one check unique identifier- Parameters:
checkId
- The identifier of the check. May benull
, in which case all registered check IDs are returned.- Returns:
- The set of unique idenfiers matching the given check identifier. May not be
null
-
getUidForShortUid
Gets the check unique identifier for the given short UID- Parameters:
shortUid
- The short UID of the check, project-specific- Returns:
- The unique identifier of the check. May be
null
if the given string isn' a short UID or non-supported marker is found
-
persistData
void persistData()Persists current check metadata to the persistent store
-