Java Doc for Modifier.java in  » Code-Analyzer » JBlanket » csdl » jblanket » modifier » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Code Analyzer » JBlanket » csdl.jblanket.modifier 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   csdl.jblanket.JBlanket
      csdl.jblanket.modifier.Modifier

Modifier
public class Modifier extends JBlanket (Code)
Provides the command line interface to modify byte code in a Java class or JAR files. This is the first step in using JBlanket.

The following tags are required command line arguments for the main methods:

    'classDir' - the directory containing all .class or .jar files to modify
    For example: -classDir c:\cvs\jblanket\build\classes

    'include' - file(s) to be modified located in classDir
    For example: -include csdl\jblanket\example\foo\Foo.class

    'exclude' - file(s) to remain untouched in classDir
    For example: -exclude csdl\jblanket\example\foo\TestFoo2.class

    'testGrammar' - grammar describing the names of the Test classes
    For example: -testGrammar Test*.class

The following tags are optional command line arguments:

    'verbose' - describes if instrumentation should execute in verbose mode
    For example: -verbose true

    'excludeOneLineMethods' - describes if one-line methods should be excluded
    For example: -excludeOneLineMethods false

    'excludeConstructors' - describes if constructors should be excluded
    For example: -excludeConstructors false

    'totalFile' - name of the XML file for all methods included in the coverage measurement
    For example: -totalFile totalMethods.xml

    'untestableFile' - name of the XML file for all abstract or native methods
    For example: -untestableFile untestableMethods.xml

    'excludedFile' - name of the XML file for all methods specifically excluded from the coverage measurement
    For example: -excludedFile excludedMethods.xml

    'oneLineFile' - name of the XML file for methods containing one line of source code
    For example: -oneLineFile oneLineMethods.xml

    'constructorFile' - name of the XML file for constructors
    For example: -constructorFile constructorMethods.xml

    'packagePrefix' - name of a package prefix to include in the coverage measurement
    For example: -packagePrefix csdl.jblanket.

Classes are modified inside the 'classDir' directory. Specify multiple files with a ';'-delimited list. Similarly, exclude multiple files with a ';'-delimited list. 'Test*.class' and '*Test.class' are the only valid grammars to describe the names of JUnit tests.

Default values provided for 'totalFile', 'untestableFile', 'excludedFile', 'oneLineFile', and 'constructorFile' are shown in the examples. However, the 'excludeOneLineMethods' or 'excludeConstructors' tags must be included to exclude methods with one line of source code or constructors from the final coverage calculation. Without the tags, percent coverage is equal to

     tested methods / (total methods - untestable methods - excluded methods)
     

With the 'excludeOneLineMethods' tag, percent coverage is equal to

     tested methods / ((total methods - untestable methods - excluded methods) - one-line methods)
     

With the 'excludeConstructors' tag, percent coverage is equal to

     tested methods / ((total methods - untestable methods - excluded methods) - constructors)
     

With both the 'excludeOneLineMethod' and 'excludeConstructors' tags, percent coverage is equal to

     tested methods / (((total methods - untestable methods - excluded methods) - one-line methods)
     - constructors)
     

author:
   Joy M. Agustin
version:
   $Id: Modifier.java,v 1.2 2005/02/19 05:55:19 timshadel Exp $



Constructor Summary
public  Modifier(boolean verbose, String testGrammar, boolean excludeOneLineMethods, boolean excludeConstructors, boolean excludeIndividualMethods, List packagePrefixes)
     Constructs a new Modifier object.

Method Summary
 voiddeleteDirectory(File dir)
     Deletes directory.
 booleanisValidTestGrammar(String testGrammar)
     Verifies if testGrammar is valid.
public static  voidmain(String args)
     Provides the command line arguments as an Array.
public static  voidmain(List args)
     Processes the command line arguments as a List.
public  voidmodify(String classDir, List includes, List excludes, List jars)
     Modifies the files in classDir in the Lists includes and jars and records the files in excludes.
protected  voidstoreMethods(MethodSet methodSet, File file)
     Stores all of the methods in methodSet to fileName.
static  ListstringToArrayList(String string)
     Transforms a ';' delimited string to an array of Strings.

Method is package private for testing purposes only, else should be private.
Parameters:
  string - the String to transform.



Constructor Detail
Modifier
public Modifier(boolean verbose, String testGrammar, boolean excludeOneLineMethods, boolean excludeConstructors, boolean excludeIndividualMethods, List packagePrefixes) throws ParseException(Code)
Constructs a new Modifier object.
Parameters:
  verbose - describes if JBlanket should execute in verbose mode.
Parameters:
  testGrammar - the grammar describing names of JUnit test classes.
Parameters:
  excludeOneLineMethods - describes if one-line methods should be excluded.
Parameters:
  excludeConstructors - describes if constructors should be excluded.
Parameters:
  excludeIndividualMethods - TODO
Parameters:
  packagePrefixes - the package prefixes to be modified.
throws:
  ParseException - if testGrammar is invalid.




Method Detail
deleteDirectory
void deleteDirectory(File dir)(Code)
Deletes directory.

Method is package private for testing purposes only, else should be private.
Parameters:
  dir - the directory to remove.




isValidTestGrammar
boolean isValidTestGrammar(String testGrammar) throws ParseException(Code)
Verifies if testGrammar is valid. The only grammars acceptable are class names that either begins or ends with 'Test' and end with either '.java' or '.class' file types.

NOTE: method is package private for testing, else should be private.
Parameters:
  testGrammar - the grammar defining test class names. true if a part of testGrammar, false otherwise.
exception:
  ParseException - if format of testGrammar is unacceptable.




main
public static void main(String args) throws IOException, Throwable(Code)
Provides the command line arguments as an Array.

See main method below.
Parameters:
  args - the command line arguments.
exception:
  IOException - if there is error reading unmodified files
throws:
  Throwable - if cannot parse an includes files.




main
public static void main(List args) throws IOException, JBlanketException, ParseException(Code)
Processes the command line arguments as a List.

The command line argument tags are as follows:

 '-classDir' - directory containing classes to modify
 '-include' - names of files found in classDir to modify
 '-exclude' - names of files found in classDir to not modify
 '-verbose' - describes if should execute in verbose mode
 '-testGrammar' - grammar describing the names of the test classes
 '-excludeOneLineMethods' - describes if should exclude one-line methods
 '-excludeConstructors' - describes if should exclude constructors
 '-totalFile' - name of the output XML file for total methods
 '-untestableFile' - name of the output XML file for untestable methods
 '-excludedFile' - name of the output XML file for excluded methods
 '-oneLineFile' - name of the output XML file for one-line methods
 '-constructorFile' - name of the output XML file for constructors
 '-packagePrefix' - package prefixes to modify if modifying JAR files
 

After this method executes, all 'include' class or JAR files in -classDir are modified.
Parameters:
  args - the List of command line arguments.
throws:
  IOException - if there is error reading unmodified files.
throws:
  JBlanketException - if unable to process files.
throws:
  ParseException - if testGrammar is invalid.




modify
public void modify(String classDir, List includes, List excludes, List jars) throws JBlanketException(Code)
Modifies the files in classDir in the Lists includes and jars and records the files in excludes.
Parameters:
  classDir - the directory containing all the subdirectories and files.
Parameters:
  includes - a List of all the class files to modify.
Parameters:
  excludes - a List of all the class files to not modify.
Parameters:
  jars - a List of all the JAR files to modify.
throws:
  JBlanketException - if unable to modify any of the files.



storeMethods
protected void storeMethods(MethodSet methodSet, File file) throws IOException(Code)
Stores all of the methods in methodSet to fileName.
Parameters:
  methodSet - the MethodSet with the methods to store in fileName.
Parameters:
  file - the output file.
throws:
  IOException - if cannot load 'totalFile', store to fileName.



stringToArrayList
static List stringToArrayList(String string)(Code)
Transforms a ';' delimited string to an array of Strings.

Method is package private for testing purposes only, else should be private.
Parameters:
  string - the String to transform. ArrayList containing the Strings delimited by ';'.




Fields inherited from csdl.jblanket.JBlanket
protected MethodCategories categories(Code)(Java Doc)
protected MethodSet constructorSet(Code)(Java Doc)
protected boolean excludeConstructors(Code)(Java Doc)
protected boolean excludeIndividualMethods(Code)(Java Doc)
protected boolean excludeOneLineMethods(Code)(Java Doc)
protected static String jblanketDir(Code)(Java Doc)
protected MethodSet oneLineSet(Code)(Java Doc)
protected MethodSet totalSet(Code)(Java Doc)
protected MethodSet untestableSet(Code)(Java Doc)
protected boolean verbose(Code)(Java Doc)

Methods inherited from csdl.jblanket.JBlanket
abstract protected void storeMethods(MethodSet methodSet, File file) throws IOException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.