Plugins API documentation: Index

Overview | Class | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

A C E F G I L M N P R S T V

## A

abbreviation - Variable in class com.togethersoft.modules.qa.api.AuditViolation
add(AuditPlugin, SciObject, SciObject) - Static method in class com.togethersoft.modules.qa.api.AuditViolations
  Adds violation
add(AuditPlugin, SciObject, SciObject, int, int) - Static method in class com.togethersoft.modules.qa.api.AuditViolations
  Adds violation
add(AuditPlugin, SciObject, SciObject, String) - Static method in class com.togethersoft.modules.qa.api.AuditViolations
  Adds violation
addProc(AuditViolation, SciObject, SciObject) - Static method in class com.togethersoft.modules.qa.api.AuditViolations
AGGR_AVERAGE - Static variable in interface com.togethersoft.modules.qa.api.MetricsPlugin
  Result for enclosing object equas the arithmetic average of the results of its parts
AGGR_MAXIMUM - Static variable in interface com.togethersoft.modules.qa.api.MetricsPlugin
  Result for enclosing object equas the maximum result of its parts
AGGR_MEDIAN - Static variable in interface com.togethersoft.modules.qa.api.MetricsPlugin
AGGR_MINIMUM - Static variable in interface com.togethersoft.modules.qa.api.MetricsPlugin
  Result for enclosing object equas the minimum result of its parts
AGGR_NONE - Static variable in interface com.togethersoft.modules.qa.api.MetricsPlugin
  No aggregation
AGGR_SUM - Static variable in interface com.togethersoft.modules.qa.api.MetricsPlugin
  Result for enclosing object equas the sum of the results of its parts
AuditPlugin - interface com.togethersoft.modules.qa.api.AuditPlugin.
AuditPluginImpl - class com.togethersoft.modules.qa.utils.AuditPluginImpl.
  Audit plugin implementation - abstract class serving as ancestor for all audit plugins
AuditPluginImpl() - Constructor for class com.togethersoft.modules.qa.utils.AuditPluginImpl
AuditViolation - class com.togethersoft.modules.qa.api.AuditViolation.
  Holds information about violation of audit plugin rules.
AuditViolation() - Constructor for class com.togethersoft.modules.qa.api.AuditViolation
AuditViolations - class com.togethersoft.modules.qa.api.AuditViolations.
  Maintains the list of audit violations, generated by all plugins The only methods that are of interest for plugin creator are `add` methods.
AuditViolations() - Constructor for class com.togethersoft.modules.qa.api.AuditViolations

## C

canProcessByteCode() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Determines whether plugin can process byte code or not.
canProcessByteCode() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Determines whether plugin can process byte code or not.
createOptionsPane() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Creates additional option pane
createOptionsPane() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Creates additional option pane.
currCls - Variable in class com.togethersoft.modules.qa.utils.PluginImpl
  stores the class that is now processed
currMbr - Variable in class com.togethersoft.modules.qa.utils.PluginImpl
  stores the member that is now processed

## E

emptyOptionsPane - Variable in class com.togethersoft.modules.qa.utils.PluginImpl
  Empty options pane.
examineExpression(SciExpression) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each expression.
exists(AuditPlugin, SciObject) - Static method in class com.togethersoft.modules.qa.api.AuditViolations
explanation - Variable in class com.togethersoft.modules.qa.api.AuditViolation

## F

fileName - Variable in class com.togethersoft.modules.qa.api.AuditViolation

## G

get(int) - Static method in class com.togethersoft.modules.qa.api.AuditViolations
getAbbreviation() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Gets the abbreviated name of plugin.
getAbbreviation() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Gets the abbreviated name of plugin.
getDefaultAggregation() - Method in class com.togethersoft.modules.qa.utils.MetricsPluginImpl
  Gets default aggregation for plugin.
getDefaultAggregation() - Method in interface com.togethersoft.modules.qa.api.MetricsPlugin
  Gets default aggregation for plugin.
getDefaultChoice() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Determines whether plugin must be chosen by default or not.
getDefaultChoice() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Determines whether plugin must be chosen by default or not.
getDefaultLowerLimit() - Method in class com.togethersoft.modules.qa.utils.MetricsPluginImpl
  Gets default lower limit value
getDefaultLowerLimit() - Method in interface com.togethersoft.modules.qa.api.MetricsPlugin
  Gets default lower limit value
getDefaultSeverity() - Method in class com.togethersoft.modules.qa.utils.AuditPluginImpl
  Gets default severity for plugin (SEVERITY_LOW, SEVERITY_NORMAL or SEVERITY_HIGH) Default implementation returns SEVERITY_NORMAL.
getDefaultSeverity() - Method in interface com.togethersoft.modules.qa.api.AuditPlugin
  Gets default severity for plugin (SEVERITY_LOW, SEVERITY_NORMAL or SEVERITY_HIGH)
getDefaultUpperLimit() - Method in class com.togethersoft.modules.qa.utils.MetricsPluginImpl
  Gets default upper limit value
getDefaultUpperLimit() - Method in interface com.togethersoft.modules.qa.api.MetricsPlugin
  Gets default upper limit value
getDescriptionFileName() - Method in class com.togethersoft.modules.qa.utils.AuditPluginImpl
  Gets the of description file name of plugin By default, description file name is the same as plugin class file name but with the extemsion of ".html".
getDescriptionFileName() - Method in class com.togethersoft.modules.qa.utils.MetricsPluginImpl
  Gets the of description file name of plugin By default, description file name is the same as plugin class file name but with the extemsion of ".html".
getDescriptionFileName() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Gets the of description file name of plugin
getGroupName() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Used for grouping of plugin.
getGroupName() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Is used for grouping of plugin.
getIntSeverity() - Method in class com.togethersoft.modules.qa.api.AuditViolation
getOptionsPane() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  returns options panel created earlier by createOptionsPane
getOptionsPane() - Method in interface com.togethersoft.modules.qa.api.Plugin
  returns options panel created earlier by createOptionsPane
getPropertiesFileName() - Method in class com.togethersoft.modules.qa.utils.AuditPluginImpl
  Gets the of properties file name of plugin By default, properties file name is the same as plugin class file name but with the extemsion of ".properties".
getPropertiesFileName() - Method in class com.togethersoft.modules.qa.utils.MetricsPluginImpl
  Gets the of properties file name of plugin By default, properties file name is the same as plugin class file name but with the extemsion of ".properties".
getPropertiesFileName() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Returns properties file name
getPropertiesFileName() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Gets the of properties file name of plugin.
getProperty(String, boolean) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Retrieves boolean property from plugin properties file.
getProperty(String, int) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Retrieves int property from plugin properties file.
getProperty(String, String) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Retrieves String property from plugin properties file.
getRelFileName() - Method in class com.togethersoft.modules.qa.api.AuditViolation
getScope() - Method in class com.togethersoft.modules.qa.utils.MetricsPluginImpl
  Gets the possible scope of plugin operation - SCOPE_CLASS or SCOPE_PROJECT.
getScope() - Method in interface com.togethersoft.modules.qa.api.MetricsPlugin
  Gets the scope on which plugin results are applicable.
getTitle() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Gets the plugin title.
getTitle() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Gets the plugin title.

## I

indent(int) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  used internally for the needs of tracing
INT_SEVERITY_HIGH - Static variable in class com.togethersoft.modules.qa.api.AuditViolation
INT_SEVERITY_LOW - Static variable in class com.togethersoft.modules.qa.api.AuditViolation
INT_SEVERITY_NORMAL - Static variable in class com.togethersoft.modules.qa.api.AuditViolation
isByteCode(SciObject) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is set to `true`, if the processing unit is in form of byte codes, otherwise is set to `false`
isDefaultPkg(SciObject) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is set to `true`, if current package is the root package otherwise is set to `false`
item - Variable in class com.togethersoft.modules.qa.api.AuditViolation
itemName - Variable in class com.togethersoft.modules.qa.api.AuditViolation

## L

level - Variable in class com.togethersoft.modules.qa.utils.PluginImpl
  nesting level - used internally for the needs of tracing
lineNum - Variable in class com.togethersoft.modules.qa.api.AuditViolation
load() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
load() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Is called upon plugin creation to perform any additional actions

## M

makeRelFileName() - Method in class com.togethersoft.modules.qa.api.AuditViolation
MetricsPlugin - interface com.togethersoft.modules.qa.api.MetricsPlugin.
MetricsPluginImpl - class com.togethersoft.modules.qa.utils.MetricsPluginImpl.
  Metrics plugin implementation - abstract class serving as ancestor for all metrics plugins
MetricsPluginImpl() - Constructor for class com.togethersoft.modules.qa.utils.MetricsPluginImpl
MetricsResult - class com.togethersoft.modules.qa.api.MetricsResult.
  Helper class used to hold metric plugin results
MetricsResult() - Constructor for class com.togethersoft.modules.qa.api.MetricsResult

## N

node - Variable in class com.togethersoft.modules.qa.api.AuditViolation
nodeQName - Variable in class com.togethersoft.modules.qa.api.AuditViolation

## P

plugin - Variable in class com.togethersoft.modules.qa.api.AuditViolation
Plugin - interface com.togethersoft.modules.qa.api.Plugin.
PluginImpl - class com.togethersoft.modules.qa.utils.PluginImpl.
  Plugin implementation - abstract class serving as ancestor for AuditPluginImpl and MetricsPluginImpl
PluginImpl() - Constructor for class com.togethersoft.modules.qa.utils.PluginImpl
posEnd - Variable in class com.togethersoft.modules.qa.api.AuditViolation
posStart - Variable in class com.togethersoft.modules.qa.api.AuditViolation
prepare() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Called after user presses the 'Start' button, before processing to carry out some additional work if need.
prepare() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Called after user presses the 'Start' button, before processing to carry out some additional work if need.
PROC_ATTRS - Static variable in class com.togethersoft.modules.qa.utils.PluginImpl
  specifies that we are processing attributes
PROC_OPERS - Static variable in class com.togethersoft.modules.qa.utils.PluginImpl
  specifies that we are processing operations
process(SciObject) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  if object `obj` corresponds to class, sets currCls to this class, currMbr to null and calls processClass(obj)
processAttrib(SciAttribute) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each attribute.
  Calls `processConceptVar` method
processAttribs(SciClass) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is invoked for each class.
processCaseStmt(SciCaseStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each case statement.
processCatchStmt(SciCatchBlockStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each catch statement.
processClass(SciClass) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is invoked by each class
  If `procGoal & PROC_ATTRS !`
processCodeBlock(SciCodeBlock) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each code block.
processCompStmt(SciCompoundStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each compound statement.
processConceptVar(SciVariable) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each atribute, parameter, or local variable.
processDeclStmt(SciDeclarationStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each declaration statement Default implementation calls `processLocalVar` for each declaration in statement.
processExpression(SciExpression) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each expression, including expressions in function calls, conditional or loop statements and so on Default implementation calls `examineExpression`, then calls `processExpression` for each expression's operand
processExprStmt(SciExpressionStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each expression.
processIfStmt(SciIfStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each if statement.
processInitValue(SciExpression) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each initialization part of class attribute or local variable.
processLocalVar(SciVariable) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each local variable.
processLoopStmt(SciLoopStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each loop statement (i.e.
processOper(SciOperation) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each operation.
  Default implementation calls `processParam` for each parameter of given operation (if any), `processThrowSpec` for each exception in the throw list of operation (if any) and then calls `processCodeBlock` for the body of operation
processOpers(SciClass) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is invoked for each class.
processParam(SciParameter) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each parameter of the operation.
  Default implementation calls `processConceptVar` for this parameter
processReturnStmt(SciReturnStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each return statement.
processStatement(SciStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each statement within code block.
processSwitchStmt(SciSwitchStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each switch statement.
processThrowSpec(SciThrowSpecifier) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each exception in the operation throw list.
processThrowStmt(SciThrowStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each throw statement.
processTryStmt(SciTryStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is called for each try-catch statement; Default implementation calls `processStatement` for the try part and for each of catch parts
procGoal - Variable in class com.togethersoft.modules.qa.utils.PluginImpl
  Defines wheather we are processing operations (PROC_OPERS), attributes(PROC_ATTRS) or both (PROC_OPERS + PROC_ATTRS)
putProperty(String, boolean) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Puts boolean property from plugin properties file.
putProperty(String, int) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Puts int property from plugin properties file.
putProperty(String, String) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Puts String property from plugin properties file.

## R

relFileName - Variable in class com.togethersoft.modules.qa.api.AuditViolation
remove(int) - Static method in class com.togethersoft.modules.qa.api.AuditViolations
reset() - Static method in class com.togethersoft.modules.qa.api.AuditViolations
restoreOptions() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
restoreOptions() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Is used to restore options from the properties file.
run(SciObject) - Method in interface com.togethersoft.modules.qa.api.AuditPlugin
  Plugin entry point.
run(SciObject, MetricsResult) - Method in interface com.togethersoft.modules.qa.api.MetricsPlugin
  Plugin entry point It is invoked for every package and every class selected in diagram as well as for each their subpackage and subclass.
run(String, SciObject, MetricsResult) - Method in class com.togethersoft.modules.qa.utils.MetricsPluginImpl
  Plugin entry point.

## S

SCOPE_CLASS - Static variable in interface com.togethersoft.modules.qa.api.MetricsPlugin
  specifies that plugin results may be applied to the classes
SCOPE_PROJECT - Static variable in interface com.togethersoft.modules.qa.api.MetricsPlugin
  specifies that plugin results may be applied only to the whole project
setSize(int) - Static method in class com.togethersoft.modules.qa.api.AuditViolations
severity - Variable in class com.togethersoft.modules.qa.api.AuditViolation
SEVERITY_HIGH - Static variable in interface com.togethersoft.modules.qa.api.AuditPlugin
  specifies that severity is high
SEVERITY_LOW - Static variable in interface com.togethersoft.modules.qa.api.AuditPlugin
  specifies that severity is low
SEVERITY_NORMAL - Static variable in interface com.togethersoft.modules.qa.api.AuditPlugin
  specifies that severity is normal
size() - Static method in class com.togethersoft.modules.qa.api.AuditViolations
stopIter - Variable in class com.togethersoft.modules.qa.utils.PluginImpl
  This flag is used to stop processing.
storeOptions() - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  Is invoked when user presses 'Start' button.
storeOptions() - Method in interface com.togethersoft.modules.qa.api.Plugin
  Is invoked when user presses 'Start' button.

## T

trace - Static variable in class com.togethersoft.modules.qa.utils.PluginImpl
  trace flag - if you set it to `true`, default implementation would print debuggung information to the console
traceAttr(SciAttribute) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  traces attribute
traceExpr(SciExpression) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  traces expression
traceOper(SciOperation) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  traces operation
traceStmt(SciStatement) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  traces statement
traceVar(String, SciVariable) - Method in class com.togethersoft.modules.qa.utils.PluginImpl
  traces variable

## V

value - Variable in class com.togethersoft.modules.qa.api.MetricsResult
  metric plugin results value
violations - Static variable in class com.togethersoft.modules.qa.api.AuditViolations

A C E F G I L M N P R S T V

Overview | Class | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES