net.pandoragames.far

Class FileMatcher

java.lang.Object

net.pandoragames.far.FileMatcher

public class FileMatcher
extends java.lang.Object

Applies regular expressions on files. The class is created with a specific regular expression Pattern that is applied when any of the methods apply(), matches() or preview() is called.

Details of the behavior is controlled through the attributes doBackup, backUpDirectory, baseDirectory and characterSet. See the respective setter methods for details.

Author:

Olivier Wehner at 24.02.2008

Constructor Summary

Constructors

Constructor and Description
FileMatcher(java.util.regex.Pattern regex) The class must be instantiated with a regular expression Pattern.

Method Summary

Methods

Modifier and Type	Method and Description
int	apply(java.io.File file, ReplacementString replacement) Applies the regex pattern and the specified replacement string to the file.
int	countMatches(java.io.File file) Returns the number of times the reges pattern can be found in the specified file.
java.io.File	getBackUpDirectory() Returns the backup directory.
java.io.File	getBackupFileName(java.io.File originalFile) Returns the abstract path name of the backup file for the specified "original" file, given the current base directory and current backup directory.
java.io.File	getBaseDirectory() Returns the base directory for backup.
java.nio.charset.Charset	getCharacterSet() Returns the character set used to read and write files.
boolean	isDoBackup() Returns the doBackup flag.
boolean	matches(java.io.File file) Returns true if the regex pattern applies to some substring in the specified file.
java.lang.String	preview(java.io.File file, ReplacementString replacement) Applies the regex pattern and the specified replacement string to the file and returns the result as string.
void	setBackUpDirectory(java.io.File backUpDirectory) Sets the backup directory.
void	setBaseDirectory(java.io.File baseDirectory) Sets the base directory.
void	setCharacterSet(java.nio.charset.Charset charset) Sets the character set used to read and write files.
void	setDoBackup(boolean doBackup) Sets the doBackup flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileMatcher

public FileMatcher(java.util.regex.Pattern regex)

The class must be instantiated with a regular expression Pattern.

Parameters:

regex - to be applied to files

Method Detail

matches

public boolean matches(java.io.File file)
                throws java.io.IOException

Returns true if the regex pattern applies to some substring in the specified file.

Parameters:

file - to be tested

Returns:

true if this instances regex pattern applies to some substring

Throws:

java.io.IOException - if the file can not be found or read

countMatches

public int countMatches(java.io.File file)
                 throws java.io.IOException

Returns the number of times the reges pattern can be found in the specified file.

Parameters:

file - to be tested

Returns:

number of matches

Throws:

java.io.IOException - if the file can not be found or read

preview

public java.lang.String preview(java.io.File file,
                       ReplacementString replacement)
                         throws java.io.IOException

Applies the regex pattern and the specified replacement string to the file and returns the result as string. Allow to test the effect of the apply() method on some particula file. Returns the string the file would contain if apply() was called.

Parameters:

file - subject of replacement but not altered

replacement - to be applied in conjunction with this instances regex pattern

Returns:

result of the replacement.

Throws:

java.io.IOException - if the file can not be found or read

apply

public int apply(java.io.File file,
        ReplacementString replacement)
          throws java.io.IOException

Applies the regex pattern and the specified replacement string to the file.

Parameters:

file - subject of replacement

replacement - to be applied in conjunction with this instances reges pattern

Returns:

true if file has been changed, false if it was not altered.

Throws:

java.io.IOException - if the file can not be found, read, written or backed up.

java.lang.IndexOutOfBoundsException - if an illegal group indicator was detected

getBackupFileName

public java.io.File getBackupFileName(java.io.File originalFile)

Returns the abstract path name of the backup file for the specified "original" file, given the current base directory and current backup directory. The method does not create the file, nore does it check if the file exists.

Parameters:

originalFile - to be backed up

Returns:

abstract path name of the back up file

getBackUpDirectory

public java.io.File getBackUpDirectory()

Returns the backup directory.

Returns:

backup directory.

See Also:

setBackUpDirectory(File)

setBackUpDirectory

public void setBackUpDirectory(java.io.File backUpDirectory)

Sets the backup directory. If the doBackup flag is set to true, files will be saved under this directory. The default for this attribute is defined by the java system property "java.io.tmpdir".

Parameters:

backUpDirectory - backup directory.

isDoBackup

public boolean isDoBackup()

Returns the doBackup flag.

Returns:

doBackup flag

See Also:

setDoBackup(boolean)

setDoBackup

public void setDoBackup(boolean doBackup)

Sets the doBackup flag. If set to true (the default), files will be saved in the current backup directory before any replacement is applied.

Parameters:

doBackup - flag should files be backed up?

getCharacterSet

public java.nio.charset.Charset getCharacterSet()

Returns the character set used to read and write files.

Returns:

charset character set

See Also:

setCharacterSet(Charset)

setCharacterSet

public void setCharacterSet(java.nio.charset.Charset charset)

Sets the character set used to read and write files. The default is to use the platforms default character set.

Parameters:

charset - character set

getBaseDirectory

public java.io.File getBaseDirectory()

Returns the base directory for backup.

Returns:

baseDirectory

See Also:

setBaseDirectory(File)

setBaseDirectory

public void setBaseDirectory(java.io.File baseDirectory)

Sets the base directory. If this attribute is set to a non null value, backed up files will be resolved relative to the specified base directory. The entire path below that directory will be copied to the backup directory, creating a copy of the subdirectory tree. This avoids overwriting files with identical names in different subdirectories during replacement operations on larger file sets.

Parameters:

baseDirectory - base directory