|
||||||||||
PREV NEXT | FRAMES NO FRAMES |
ExampleCodeMouseListener
Listener to Enter/Exit events on the widgets.AbstractResultsFormatter
- Shows the results on the console in a compiler
typcial way addActionListener
ArgProcessor
is a generic argument processor for single character options
to be passed in into a command line program.assertFalse
- check if the boolean expression returns a true value
assertFalse
- check if the boolean expression returns a true value
assertTrue
- check if the boolean expression returns a true value
assertTrue
- check if the boolean expression returns a true value
boolean2String
converts a boolean value into
a String represnting the value - 'true', 'false'
ConsoleResultsFormatter
- Shows the results on the console in a compiler
typcial wayDecimalNumberDocument
only accepts deciaml characters (0-9).defineOptions
- with this method the allowed arguments are defined.
EITHER
- either boolean true or false
escapeNewLine
replaces \n with \\n in a string
execute
method here.
executeFile
runs JCSC on one File
executeFiles
runs JCSC on an array of Files
FALSE
FileFinder
is helper clas which assists in getting all files
from a folder. fireActionPerformed
- called when an action has happened,
either on the TextField or on the Button.
getArgumentOption
- returns the value or the option
getArguments
- returns the real arguments; the command arguments
getAuthors
- get list of all @authors as
a comma separated string
getAuthors
getAuthorTags
returns all the author tags
getCCNCount
getClassName
getClassName
getColumn
getColumn
getDeprecatedTags
returns all the deprecated tags
getComponentText
- getValue the text from the component
getExpressionText
getExpressionText
getFiles
transforms FileSet into an File array
getHelpCtx
return the the help context
getLine
getLine
getMessage
getMethodName
getMethodName
getMethodsCount
- call this method after a successful
parse to obtain the number of methods
getName
returns the name of the action
getName
returns the name of the tab
getNCSS
- get the count of NCSS
non commenting source statements
getNCSSCount
getOrder
returns the tags in the order they appeared
getOrderConvention
return the recomended order of the tags
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
getPackageName
getParaCount
getParameterName
getParameterType
getParamTags
returns all the param tags
getRegexp
getReturnTags
returns all the return tags
getRule
getSeeTags
returns all the see tags
getSerialTags
returns all the see tags
getSinceTags
returns all the since tags
getSource
getState
returns the current state
getTabs
returns a list of all tab in the order they appear on the ui.
getTestString
getObject
getThrowsTags
returns all the see tags
getUnitTestClassCount
- call this method after a successful
parse to obtain the number of Unit test classes
getUnitTestsCount
- call this method after a successful
parse to obtain the number of Unit tests
getVersionTags
returns all the version tags
getViolations
- call this method after a successful
parse to obtain a List of violations.
getViolationsCount
- call this method after a successful
parse to obtain the number of violations
handleComplexLoopExpression
checks break condition is based
on an operation rather then on a constant
handleConditionalExpression
checks if cond expression are
allowd or not
handleConstructorDeclarationJavaDoc
handles the javadoc for
constructor declarations.
handleFieldDeclarationJavaDoc
handles the javadoc for
field declarations.
handleJavaDocTagOrder
handles if the javadoc tag order correct
handleMethodDeclarationJavaDoc
handles the javadoc for
method declarations.
handleSpaceAfterMethodName
checks if the space count is not '0'.
handleSpaceAfterStatementKeyword
checks if the space count is not '0'.
handleSpaceAroundBinaryExpression
checks space Around Binary Expression
handleStringLiteral
checks if String literal is allowed
handleTypeDeclarationJavaDoc
handles the javadoc for
class declarations.
handleTypeHeaderExpression
handles if the type (class/i-face) do start
with the correct header
hasAuthorTags
hasDeprecatedTags
hasFlagOption
- returns if the flag option is set
hasOption
- check if a certain option exists; the option can either be
a flag or an option with a value
hasParamTags
hasReturnTags
hasSeeTags
hasSerialTags
hasSinceTags
hasThrowsTags
hasVersionTags
iconResource
return the abs path of the icon
incrementSpace
is called by the tokenizer when a space is read
insertString
argValid
- check if the boolean expression returns a true value
argValid
- check if the boolean expression returns a true value
isEither
indicates whether the state is either
isFalse
indicates whether the state is false
isJavaDoc
returns wheter the string is a javadoc.
notNull
- check if an object has no null reference
notNull
- check if an object has no null reference
isOrderCorrect
returns whether the order of the tags
complies with the order convention.
isRegexpMatch
return whether the regexp matches the value.
isTrue
indicates whether the state is true
JavaDocParser
is an immutable class to getValue javadoc
data in tag granularity.JavaDocParser
instance.
JcscTab
has to be realized by all tabs on the JCSC RulesPanel
which is displayed on the RulesDialog.JCSCTask
main
for command line testing purpose
main
brings up the RulesDialog
mAuthors
the authors of that class; if several authors
then names are separated by ','
mClass
the name of the class
MethodMetric
- a metric for a methodMethodMetric
instance.
mMethodMetrics
the collection of all metrics
mNCSSCount
the number of methods (non commenting source statements)
mNCSSCount
the number of NCSS (non commenting source statements)
mouseClicked
mouseEntered
mouseExited
mousePressed
mouseReleased
mOutputStream
is the stream to write the formated output
mPackage
the package the class belongs to
mUnitTestClassCount
the number of Unit test classes
mUnitTestsCount
the number of Unit tests
mViolations
the collection of all violations
mViolationsCount
the number of vioalations
NetBeansOutputStream
instance.
openRulesFile
brings up a file chooser to choose a .jcsc file
OveriewStatistics
is used to keep track about
all information of all classes which are parsed.PackageStatistics
is used to keep track about
all information of a package.PackageStatistics
instance.
parse
- do the parsing!!!
performAction
called from NB to execute
processWindowEvent
- overwrited JFrame method
processWindowEvent
- overwrited JFrame method
putArguments
- put a string containing all options and arguments separated by a
white space into the ArgumentProcessor
putArguments
- put an array of options and arguments into the
ArgurmentProcessor.
RegexpDialog
is a dialog assisting in regexp creationRegTextArea
is a wrapped up JTextAreaRegTextArea
RegTextField
is a wrapped up JTextFieldRegTextField
RegexpDialog
instance.
RegexpDialog
instance.
RegexpDialog
instance.
RegexpDialogTextComponent
is a component which can be
used for text input. removeActionListener
removeCR
removes all the CR within a string
resetNewLine
resets the new line flag to false
resetSpaceCount
resets the current space count to '0'
ResultsFormatter
- Formatter of the parsing results.Return
Collection of Return classes; used by the grammar to
return complex return valuesFormalParameterReturn
FormalParameterReturn
instance.
MethodDeclaratorReturn
MethodDeclaratorReturn
instance.
RuleConstants
contains all the constants which are
used for rule property file.RulesDialog
is the dialog in which the rules for JCSC can
be specified.RulesDialog
instance.
RulesDialog
instance.
RulesDialog
instance.
RulesHandler
is a helper class which is resoponsibel for saving the
rules properties.RulesPanel
is a Swing UI JPanel to visually set the JCSC propertiesRulesPanel
instance.
setAuthors
- set the values of the @author tags found
setAuthors
setCCNCount
setClassName
setClass
- the name of the class
setClassName
setColumn
setColumn
setDestdir
- the folder into which the output is
written to.
setComponentText
- set the text int the component
setExpressionText
setExpressionText
setFailValue
set the fail value which
will cause a failure if the avg violations per ncss is higher.
setFile
- the name of the single file to check.
setFileName
- set the absolute path of the file
to be parsed
setLastJavaDoc
set the last JavaDoc of the current class
setLine
setLine
setMessage
setMethodMetrics
- set all the method metrics
setMethodMetrics
setMethodName
setMethodsCount
- the number of methods count
setMethodsCount
setNCSSCount
- the number of NCSS
non commenting source statements
setNCSSCount
setNCSSCount
setNewLine
resets the new line flag to true
setOutputStream
- set the outputstream to write to
setOutputStream
setPackage
- the name of the package the class belongs to
setPackage
setPackageName
setRegexp
setResultsFormatter
- set the resulsthander to handle
the violations.
setResultsformatter
- the results formatter to use.
setRule
setRules
passes in the cache of the processed
XML.
setRules
- the rules file to use.
setSource
setStartDate
set the date/time from which files
are being considered.
setStartpackage
- the name of the topmost package
with the tailing '.' (i.e com.foo....
setTestString
setObject
setUnitTestClassCount
- the count of unit test classes
setUnitTestClassCount
setUnitTestsCount
- the count of unit tests
setUnitTestsCount
setViolations
- set all the violations which occured
setViolations
setViolationsCount
- the count of violations
setViolationsCount
setWorstCount
- how many files should be part
of the hall of 'shame'.
convertString2Boolean
converts a String value into
a boolean representing the value - 'true', 'false'.
TextFieldButton is a JTextField widget with a browse button
Example for typical usage:
// listener for action event from mTextFieldButton an instance of TextFieldButton
public void actionPerformed(ActionEvent e)
{
if (e.getActionCommand().equals(TextFieldButton.AC_BUTTON))
{
final SomeDialog sd = new SomeDialog(); // some selection happens here
sd.setActionListener(new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
// update what is displayed in the textfield of the TextFieldButton
mTextFieldButton.setObject(((SomeDialog) e.getSource()).getSelection());
sd.dispose();
}
});
}
sd.pack();
sd.setVisible(true);
}
TextFieldButton
instance.
TextFieldButton
instance.
TextFieldButton
instance.
toString
TriStateBoolean
is a boolean which can have
three states - true, false, either.TriStateBoolean
creates a new TriStateBoolean instance
TRUE
unescapeNewLine
replaces \\n with \n
Violation
- a violation and its informationwrite
a character to the the stream
XMLResultsFormatter
- Outputs the results in XML
|
||||||||||
PREV NEXT | FRAMES NO FRAMES |