net.sourceforge.sql2java

Class UserCodeParser

java.lang.Object

net.sourceforge.sql2java.UserCodeParser

public class UserCodeParser
extends Object

Parses an existing source file for special sql2code comment blocks.
Stores the source code that it finds in between those blocks in a hashtable. This allows CodeWriter classes to rewrite existing files while preserving code written by the user.

Version:

$Id: UserCodeParser.java,v 1.1 2005/10/12 18:44:24 framiere Exp $

Author:

James Cooper

Constructor Summary

Constructors

Constructor and Description
UserCodeParser(String filename) Constructs a new parser, and tells the parser to try to load the given filename.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBlock(String name) Returns the comment+code block associated with this name.
String[]	getBlockNames() Returns an array of the block names parsed in the existing file.
String	getFilename() Returns the filename associated with this parser.
boolean	hasBlock(String name) Returns true if there is a block with the given name in the existing file that was parsed, otherwise returns false.
boolean	isNew() Returns true if the file to parse did not exist.
void	parse(String filename) Parses the file passed in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserCodeParser

public UserCodeParser(String filename)
               throws Exception

Constructs a new parser, and tells the parser to try to load the given filename.
If the file does not exist, the parser will simply initialize a new hashtable internally, and the get methods on the parser will return new comment blocks (with nothing in between them).

Parameters:

filename - Full path to the existing file to parse.

Throws:

Exception - if the existing file exists, but cannot be read, or if there is an error while reading the file

Method Detail

getFilename

public String getFilename()

Returns the filename associated with this parser.

isNew

public boolean isNew()

Returns true if the file to parse did not exist.

parse

public void parse(String filename)
           throws Exception

Parses the file passed in.

Throws:

Exception

hasBlock

public boolean hasBlock(String name)

Returns true if there is a block with the given name in the existing file that was parsed, otherwise returns false.

Parameters:

name - Name of the code block to check for.

getBlock

public String getBlock(String name)

Returns the comment+code block associated with this name.
If the name is not found in the parsed file, this returns a new comment block with no code inside it.

Parameters:

name - Name of the code block to return.

getBlockNames

public String[] getBlockNames()

Returns an array of the block names parsed in the existing file.
If the file did not exist, or if there are no blocks in the file, a zero length array is returned.