Class CategoryDefinition
java.lang.Object
soot.jimple.infoflow.android.data.CategoryDefinition
- All Implemented Interfaces:
ISourceSinkCategory
A category definition for a source or sink method
- Author:
- Steven Arzt
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCategoryDefinition(String categoryId) Creates a new instance of theCategoryDefinitionclassCategoryDefinition(String customCategoryId, String humanReadableNmae) Creates a new instance of theCategoryDefinitionclass -
Method Summary
Modifier and TypeMethodDescriptionbooleanGets the user-defined category id.Gets the category description as a string.getID()Gets a variant of this description that only contains identifiers.inthashCode()voidsetCategoryId(String id) Sets the user-defined category id.toString()
-
Field Details
-
ALL_CATEGORIES
-
-
Constructor Details
-
CategoryDefinition
Creates a new instance of theCategoryDefinitionclass- Parameters:
categoryId- user-defined category ID
-
CategoryDefinition
Creates a new instance of theCategoryDefinitionclass- Parameters:
customCategoryId- A user-defined category IDhumanReadableNmae- An optional human-readable name
-
-
Method Details
-
getCategoryId
Gets the user-defined category id.- Returns:
- The user-defined category id
-
setCategoryId
Sets the user-defined category id. This is an identifier for the system. To define a human-readable category description, use the setCustomDescription() instead.- Parameters:
id- The user-defined category id. Category identifiers must be unique.
-
hashCode
public int hashCode() -
equals
-
toString
-
getHumanReadableDescription
Gets the category description as a string. This method either returns a human-readable description for the current system category or the user-defined category if the system-defined category is "NO_CATEGORY", but a user-defined category is available.- Specified by:
getHumanReadableDescriptionin interfaceISourceSinkCategory- Returns:
- The category description as a string
-
getIdOnlyDescription
Gets a variant of this description that only contains identifiers. Such a variant is helpful when trying to identify the category in a collection in which not necessary all meta data is available.- Returns:
- A variant of this category definition that only contains identifiers, but not, e.g., descriptions
-
getID
- Specified by:
getIDin interfaceISourceSinkCategory
-