comtest
Class ComTest.ComTestScanner

java.lang.Object
  extended by comtest.ComTest.ComTestScanner
Enclosing class:
ComTest

public static class ComTest.ComTestScanner
extends java.lang.Object

Class to do the file scanning and output for test class

Author:
vesal

Nested Class Summary
 class ComTest.ComTestScanner.CommentCodeHandler
          Handles to ComTest-comment and returns the position of last handled line.
 
Field Summary
private  java.lang.String ALMOSTMARKER1
           
private  java.lang.String ALMOSTMARKER2
           
private  java.lang.String className
           
private  java.lang.String COLUMNCHAR
           
private  java.lang.String COLUMNSEPARATOR
           
private  java.lang.String comTestIni
           
private  Strings contents
           
private  java.lang.String DELETESENTENCEMARKER
           
private  java.lang.String directory
           
private  java.lang.String DIRECTORYMARKER
           
private  boolean doStaticImport
           
private  java.lang.String EQUALSMARKER
           
private  java.lang.String EQUALSMARKER2
           
private  java.lang.String EVERYLINEINITS1
           
private  java.lang.String EVERYLINEINITS2
           
private  java.lang.String IMPORTMARKER
           
private  Strings imports
           
private  java.lang.String INITLINE
           
private static java.lang.String JAVAIMPOPRT
           
private  boolean noAutoImport
           
private  java.lang.String originalPackageName
           
private  java.lang.String outDirName
           
private  java.lang.String outFileName
           
private  Strings outlines
           
private  java.lang.String PACKAGEMARKER
           
private  java.lang.String packageName
           
private  int printedTableLines
           
private  java.lang.String REGEXPMARKER1
           
private  java.lang.String REGEXPMARKER2
           
private  java.lang.String TEMPLATELINEMARKER
           
private  java.lang.String testClassName
           
private  java.lang.String testFilePackageName
           
private  java.lang.String THROWSMARKER
           
private  java.lang.String TOLERANCE
           
 
Constructor Summary
ComTest.ComTestScanner(Strings contents)
          Constructs the new ComTestScanner from stringlist contents
 
Method Summary
private  int addIfNotAllready(int i, java.lang.String s)
          Adds the line s+"\n" to outlines if it is not there already.
private  void addImports()
          Add imports-list to outlines Also if doStaticImport is true then add also static import
private  void addOut(java.lang.String s)
          Add string s to outlines
private  void addOut(Strings list)
          Add strings from list to outlines by separating from new line
private  void addOut(Strings list, java.lang.String target, java.lang.String replacement)
          Prints the stringlist by replacing target-strings by replacement strings Separator is not printed after last line
private  void addOutln(java.lang.String s)
          Add string s to outlines with new line
private  void checkFileNameOnceAgain(java.lang.String fileName)
          May change outFileName to same directory, if no package
private  void checkIniOptions(java.lang.String filename)
          Climb up from filename and find first ComTest.ini and read that
 void checkOptionLine(java.lang.String line, boolean all)
          Check the selected line by ComTest options
private  void checkOptions(Strings contents, boolean all)
          Check the selected contents by ComTest options
private  java.lang.String checkVariable(java.lang.String s, java.lang.String varName)
          Check if s is a substitution to specified variable
private  boolean checkVariables(java.lang.String st)
          Check is d is substitution to any know variable
 ComTest.ComTestScanner.CommentCodeHandler createCommentCodeHandler()
          This factory method is just for testing purposes
private  void createTestFileBegin()
          Reads possible old file and removes all ComTest generated code and create the output to outlines
private  void createTestFileInner()
          Creates the inner part of test class
private  Strings delete(Strings list, java.lang.String target, java.lang.String quotes)
          Deletes from the list all lines that contains target outside of quotes and comments
private static void deleteComTestLines(Strings testContents, Strings outlines)
          Scans String list and deletes all lines written by ComTest
 boolean findNames(java.lang.String fileName)
          Find outName and className from fileName
private  boolean findPackage(Strings contents)
          Finds the package line from contents.
private static java.lang.String getComTestVersion()
          Returns version string for class comments
 Strings getOutlines()
          This method is just for testing purposes to return current outlines.
private  boolean handleDirAndPackage(java.lang.String line)
          Handles directory and package specific lines
private  boolean handleImports(java.lang.String line)
          Checks if s is for setting imports.
private  void println(java.io.PrintWriter out, Strings list, java.lang.String sep)
          Prints the stringlist by replacing target-strings by replacement strings
 java.lang.String scan(java.lang.String fileName)
          Scan the contents and make a test class
private static java.lang.String two(int i)
          Returns integer i by at least two characters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

JAVAIMPOPRT

private static final java.lang.String JAVAIMPOPRT
See Also:
Constant Field Values

contents

private final Strings contents

imports

private final Strings imports

outlines

private Strings outlines

doStaticImport

private boolean doStaticImport

noAutoImport

private boolean noAutoImport

className

private java.lang.String className

outFileName

private java.lang.String outFileName

outDirName

private java.lang.String outDirName

testClassName

private java.lang.String testClassName

packageName

private java.lang.String packageName

originalPackageName

private java.lang.String originalPackageName

testFilePackageName

private java.lang.String testFilePackageName

directory

private java.lang.String directory

comTestIni

private java.lang.String comTestIni

printedTableLines

private int printedTableLines

COLUMNSEPARATOR

private java.lang.String COLUMNSEPARATOR

COLUMNCHAR

private java.lang.String COLUMNCHAR

TEMPLATELINEMARKER

private java.lang.String TEMPLATELINEMARKER

DELETESENTENCEMARKER

private java.lang.String DELETESENTENCEMARKER

INITLINE

private java.lang.String INITLINE

EVERYLINEINITS1

private java.lang.String EVERYLINEINITS1

EVERYLINEINITS2

private java.lang.String EVERYLINEINITS2

EQUALSMARKER

private java.lang.String EQUALSMARKER

EQUALSMARKER2

private java.lang.String EQUALSMARKER2

ALMOSTMARKER1

private java.lang.String ALMOSTMARKER1

ALMOSTMARKER2

private java.lang.String ALMOSTMARKER2

REGEXPMARKER1

private java.lang.String REGEXPMARKER1

REGEXPMARKER2

private java.lang.String REGEXPMARKER2

TOLERANCE

private java.lang.String TOLERANCE

THROWSMARKER

private java.lang.String THROWSMARKER

IMPORTMARKER

private java.lang.String IMPORTMARKER

PACKAGEMARKER

private java.lang.String PACKAGEMARKER

DIRECTORYMARKER

private java.lang.String DIRECTORYMARKER
Constructor Detail

ComTest.ComTestScanner

ComTest.ComTestScanner(Strings contents)
Constructs the new ComTestScanner from stringlist contents

Parameters:
contents - where to scan the comment tests
Method Detail

handleImports

private boolean handleImports(java.lang.String line)
Checks if s is for setting imports. If is, then true is returned and the import is handled.

Parameters:
line - line to check
Returns:
true if import line, false otherwise

handleDirAndPackage

private boolean handleDirAndPackage(java.lang.String line)
Handles directory and package specific lines

Parameters:
line - line to handle
Returns:
true if handled

checkVariable

private java.lang.String checkVariable(java.lang.String s,
                                       java.lang.String varName)
Check if s is a substitution to specified variable

Parameters:
s - string to looks for
varName - varName to look
Returns:
new value for variable, null if not variable

checkVariables

private boolean checkVariables(java.lang.String st)
Check is d is substitution to any know variable

Parameters:
st - string to check
Returns:
true if any variable, false otherwise

addOut

private void addOut(java.lang.String s)
Add string s to outlines

Parameters:
s -

addOutln

private void addOutln(java.lang.String s)
Add string s to outlines with new line

Parameters:
s -

addOut

private void addOut(Strings list)
Add strings from list to outlines by separating from new line

Parameters:
list - strings to add

println

private void println(java.io.PrintWriter out,
                     Strings list,
                     java.lang.String sep)
Prints the stringlist by replacing target-strings by replacement strings

Parameters:
out - stream to print
list - stringlist to print
sep - string to separate items

addOut

private void addOut(Strings list,
                    java.lang.String target,
                    java.lang.String replacement)
Prints the stringlist by replacing target-strings by replacement strings Separator is not printed after last line

Parameters:
list - stringlist to print
target - string that is replaced
replacement - string by what to replace

delete

private Strings delete(Strings list,
                       java.lang.String target,
                       java.lang.String quotes)
Deletes from the list all lines that contains target outside of quotes and comments

Parameters:
list - where to delete
target - what is condition for delete
Returns:
the list itself

getOutlines

public Strings getOutlines()
This method is just for testing purposes to return current outlines.

Returns:
current outlines.

createCommentCodeHandler

public ComTest.ComTestScanner.CommentCodeHandler createCommentCodeHandler()
This factory method is just for testing purposes

Returns:
a new handler

two

private static java.lang.String two(int i)
Returns integer i by at least two characters

Parameters:
i -
Returns:
i by at least two characters

getComTestVersion

private static java.lang.String getComTestVersion()
Returns version string for class comments


deleteComTestLines

private static void deleteComTestLines(Strings testContents,
                                       Strings outlines)
Scans String list and deletes all lines written by ComTest

Parameters:
testContents - list to scan
outlines - list where is the result (all lines with \n)

checkFileNameOnceAgain

private void checkFileNameOnceAgain(java.lang.String fileName)
                             throws java.io.IOException
May change outFileName to same directory, if no package

Parameters:
fileName - name to use as a base name
Throws:
java.io.IOException

findNames

public boolean findNames(java.lang.String fileName)
                  throws java.io.IOException
Find outName and className from fileName

Parameters:
fileName - name to look;
Returns:
true
Throws:
java.io.IOException

findPackage

private boolean findPackage(Strings contents)
Finds the package line from contents. Substitutes to packageName

Parameters:
contents - where to find
Returns:
true if found

createTestFileBegin

private void createTestFileBegin()
                          throws java.io.IOException
Reads possible old file and removes all ComTest generated code and create the output to outlines

Throws:
java.io.IOException - if outPutFile is not possible to open

createTestFileInner

private void createTestFileInner()
Creates the inner part of test class


checkOptionLine

public void checkOptionLine(java.lang.String line,
                            boolean all)
Check the selected line by ComTest options

Parameters:
line - what to check
all - to check all or only part
Example:
  TestHelpper t = new TestHelpper();
  t.scanner.checkOptionLine("    * #import imp1; // ", true);
  t.imports.get(0) === "import imp1;";
  t.scanner.checkOptionLine("    *  #import imp2; // ", true);
  t.imports.size() === 1; 
  t.scanner.checkOptionLine("    // #import imp2; // ", true);
  t.imports.get(1) === "import imp2;";
  t.scanner.checkOptionLine("    //#import imp3; // ", true);
  t.imports.get(2) === "import imp3;";
  t.scanner.checkOptionLine("    *#import imp4; // ", true);
  t.imports.get(3) === "import imp4;";
  t.scanner.checkOptionLine("    //  #import imp5; // ", true);
  t.imports.size() === 4; 
 

checkOptions

private void checkOptions(Strings contents,
                          boolean all)
Check the selected contents by ComTest options

Parameters:
contents - what to check
all - to check all or only part

addIfNotAllready

private int addIfNotAllready(int i,
                             java.lang.String s)
Adds the line s+"\n" to outlines if it is not there already. The line "is there" if trim of it starts with s

Parameters:
i - place to add if not already there
s - line to add if not found
Returns:
next place to add so i+1 if added, i if not

addImports

private void addImports()
Add imports-list to outlines Also if doStaticImport is true then add also static import


checkIniOptions

private void checkIniOptions(java.lang.String filename)
Climb up from filename and find first ComTest.ini and read that

Parameters:
filename - name with path to start climbing

scan

public java.lang.String scan(java.lang.String fileName)
Scan the contents and make a test class

Parameters:
fileName - filename read to contents
Returns:
outName if ok, null if something wrong