FARConfig (FAR - Find And Replace)

java.lang.Object
- net.pandoragames.far.ui.FARConfig

Direct Known Subclasses:

SwingConfig
```
public class FARConfig
extends java.lang.Object
```
Data container for configuration values.

Author:

Olivier Wehner

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APPLICATION_NAME` The applications (short) name: FAR
`static java.lang.String`	`APPLICATION_TITLE` The application title: Find And Replace
`static java.lang.String[]`	`GROUPREFINDICATORLIST` The set of possible group reference indicators.
`protected org.apache.commons.logging.Log`	`logger`
`static int`	`MIN_JAVA_MINOR_VERSION` Requires Java version.
`static java.lang.String`	`PPT_BASEDIR` Property name for base directory.
`static java.lang.String`	`PPT_BCKPDIR` Property name for backup directory.
`static java.lang.String`	`PPT_BINARY` Property name for process binary flag.
`static java.lang.String`	`PPT_GROUPREF` Property name for group reference indicator.
`static java.lang.String`	`PPT_LISTEXDIR` Property name for file list export directory.
`static java.lang.String`	`PPT_UNKNOWN_AS_BINARY` Property name for the treat-unknown-file-types-as-binary flag.
`static java.lang.String`	`PPT_VERSION` Property name for version number.
`static java.lang.String`	`STANDARD_DATE_FORMAT` Standard date format: yyyy-MM-dd
`static java.lang.String`	`STANDARD_DATE_TIME_FORMAT` Standard ISO 8601 date time format.
`static java.lang.String`	`STANDARD_TIME_FORMAT` Standard time format: hh:mm

Constructor Summary

Constructors
Constructor and Description

FARConfig()

Constructors
Constructor and Description
`FARConfig()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.io.File`	`getBackupDirectory()` Returns the default backup directory.
`java.io.File`	`getBaseDirectory()` Returns the lastBaseDir.
`java.util.List<java.nio.charset.Charset>`	`getCharsetList()` Returns the list of available character sets.
`java.io.File`	`getConfigDir()` Returns the directory for configuration options.
`java.nio.charset.Charset`	`getDefaultCharset()` Returns the default character set.
`ExtractForm`	`getDefaultExtractForm()` Returns a new ExtractForm with default settings.
`FindForm`	`getDefaultFindForm()` Returns a new FindForm with default settings.
`RenameForm`	`getDefaultRenameForm()` Returns a new RenameForm with default settings.
`ReplaceForm`	`getDefaultReplaceForm()` Returns a new ReplaceForm with default settings.
`static int`	`getEffectiveJavaVersion()` Returns the "effective" java version, i.e.
`java.io.File`	`getFileListExportDirectory()` Returns the default directory for file list import and export.
`protected java.util.List<FileNamePattern>`	`getFileNamePatternList()`
`FileNamePatternComboboxModel`	`getFileNamePatternListModel()` Returns the list of predefined FileNamePatterns
`char`	`getGroupReferenceIndicator()` Returns the currently set group reference indicator.
`Localizer`	`getLocalizer()` Returns the Localizer to be used for labels and messages.
`boolean`	`isProcessBinary()` If this flag is set to true, binary files will be processed in replace operations like any others.
`boolean`	`isTreatUnknownFileTypesAsBinary()` Should unknown file types be treated as binary files.
`protected void`	`loadFromProperties(java.util.Properties properties)` Loads the base and the backupd directory from a Properties object.
`void`	`setBackupDirectory(java.io.File backupDirectory)` Sets the default backup directory.
`void`	`setBaseDirectory(java.io.File baseDir)` Sets the default base directory.
`protected void`	`setCharsetList(java.util.List<java.nio.charset.Charset> charsetList)` Sets the list of available character sets.
`protected void`	`setConfigDir(java.io.File dir)` Sets the directory for configuration options.
`void`	`setDefaultCharset(java.nio.charset.Charset charset)` Sets the default character set.
`void`	`setFileListExportDirectory(java.io.File exportDir)` Sets the default directory for file list import and export.
`void`	`setGroupReferenceIndicator(char groupReferenceIndicator)` Sets the group reference indicator.
`void`	`setLocalizer(Localizer localizer)` Sets the Localizer to be used.
`protected void`	`setPatternList(java.util.List<FileNamePattern> fileNamepattern)` Sets the file name pattern list.
`void`	`setProcessBinary(boolean processBinary)` Sets the process binary files flag.
`void`	`setTreatUnknownFileTypesAsBinary(boolean treatUnknwonFileTypesAsBinary)` Should unknown file type be treated as binary files.
`boolean`	`versionHasChanged()` Returns true if the application version has changed since the last run.
`protected void`	`writeToProperties(java.util.Properties properties)` The inverse operation to `loadFromProperties()`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MIN_JAVA_MINOR_VERSION
```
public static final int MIN_JAVA_MINOR_VERSION
```
    Requires Java version.
    
    See Also:
    Constant Field Values
  - APPLICATION_NAME
```
public static final java.lang.String APPLICATION_NAME
```
    The applications (short) name: FAR
    
    See Also:
    Constant Field Values
  - APPLICATION_TITLE
```
public static final java.lang.String APPLICATION_TITLE
```
    The application title: Find And Replace
    
    See Also:
    Constant Field Values
  - PPT_BASEDIR
```
public static final java.lang.String PPT_BASEDIR
```
    Property name for base directory.
    
    See Also:
    Constant Field Values
  - PPT_BCKPDIR
```
public static final java.lang.String PPT_BCKPDIR
```
    Property name for backup directory.
    
    See Also:
    Constant Field Values
  - PPT_LISTEXDIR
```
public static final java.lang.String PPT_LISTEXDIR
```
    Property name for file list export directory.
    
    See Also:
    Constant Field Values
  - PPT_GROUPREF
```
public static final java.lang.String PPT_GROUPREF
```
    Property name for group reference indicator.
    
    See Also:
    Constant Field Values
  - PPT_VERSION
```
public static final java.lang.String PPT_VERSION
```
    Property name for version number.
    
    See Also:
    Constant Field Values
  - PPT_BINARY
```
public static final java.lang.String PPT_BINARY
```
    Property name for process binary flag.
    
    See Also:
    Constant Field Values
  - PPT_UNKNOWN_AS_BINARY
```
public static final java.lang.String PPT_UNKNOWN_AS_BINARY
```
    Property name for the treat-unknown-file-types-as-binary flag.
    
    See Also:
    Constant Field Values
  - GROUPREFINDICATORLIST
```
public static final java.lang.String[] GROUPREFINDICATORLIST
```
    The set of possible group reference indicators. "\", "$" and "%".
  - STANDARD_DATE_TIME_FORMAT
```
public static final java.lang.String STANDARD_DATE_TIME_FORMAT
```
    Standard ISO 8601 date time format.
    
    See Also:
    Constant Field Values
  - STANDARD_DATE_FORMAT
```
public static final java.lang.String STANDARD_DATE_FORMAT
```
    Standard date format: yyyy-MM-dd
    
    See Also:
    Constant Field Values
  - STANDARD_TIME_FORMAT
```
public static final java.lang.String STANDARD_TIME_FORMAT
```
    Standard time format: hh:mm
    
    See Also:
    Constant Field Values
  - logger
```
protected org.apache.commons.logging.Log logger
```
- Constructor Detail
  - FARConfig
```
public FARConfig()
```
- Method Detail
  - getEffectiveJavaVersion
```
public static int getEffectiveJavaVersion()
```
    Returns the "effective" java version, i.e. the "minor" verision returned by the system property "java version". Returns 4 for java 1.4.x, 5 for java 1.5.x and so on. Returns 0 (zero) if the System property "java.version" could not be parsed.
    
    Returns:
    "effective" java version as a positive integer
  - getBaseDirectory
```
public java.io.File getBaseDirectory()
```
    Returns the lastBaseDir.
    
    Returns:
    lastBaseDir
  - getLocalizer
```
public Localizer getLocalizer()
```
    Returns the Localizer to be used for labels and messages.
    
    Returns:
    Localizer instance
  - setLocalizer
```
public void setLocalizer(Localizer localizer)
```
    Sets the Localizer to be used.
    
    Parameters:
    localizer - for labels and messages
  - getFileNamePatternListModel
```
public FileNamePatternComboboxModel getFileNamePatternListModel()
```
    Returns the list of predefined FileNamePatterns
    
    Returns:
    predefined patterns.
  - getBackupDirectory
```
public java.io.File getBackupDirectory()
```
    Returns the default backup directory.
    
    Returns:
    default backup directory
  - getCharsetList
```
public java.util.List<java.nio.charset.Charset> getCharsetList()
```
    Returns the list of available character sets.
    
    Returns:
    available character sets
  - getDefaultCharset
```
public java.nio.charset.Charset getDefaultCharset()
```
    Returns the default character set.
    
    Returns:
    default character set
  - setDefaultCharset
```
public void setDefaultCharset(java.nio.charset.Charset charset)
```
    Sets the default character set.
    
    Parameters:
    charset - default character set to be used
  - getFileListExportDirectory
```
public java.io.File getFileListExportDirectory()
```
    Returns the default directory for file list import and export.
    
    Returns:
    default directory for file list import and export
  - getGroupReferenceIndicator
```
public char getGroupReferenceIndicator()
```
    Returns the currently set group reference indicator. This is a single character, indicating group references in regular expressions.
    
    Returns:
    currently set group reference indicator
  - setGroupReferenceIndicator
```
public void setGroupReferenceIndicator(char groupReferenceIndicator)
```
    Sets the group reference indicator. This is a single character, indicating group references in regular expressions.
    
    Parameters:
    groupReferenceIndicator - group reference indicator
  - getDefaultFindForm
```
public FindForm getDefaultFindForm()
```
    Returns a new FindForm with default settings.
    
    Returns:
    default FindForm
  - getDefaultReplaceForm
```
public ReplaceForm getDefaultReplaceForm()
```
    Returns a new ReplaceForm with default settings.
    
    Returns:
    default ReplaceForm
  - getDefaultRenameForm
```
public RenameForm getDefaultRenameForm()
```
    Returns a new RenameForm with default settings.
    
    Returns:
    default RenameForm
  - getDefaultExtractForm
```
public ExtractForm getDefaultExtractForm()
```
    Returns a new ExtractForm with default settings.
    
    Returns:
    default ExtractForm
  - versionHasChanged
```
public boolean versionHasChanged()
```
    Returns true if the application version has changed since the last run.
    
    Returns:
    true if application version has changed.
  - isTreatUnknownFileTypesAsBinary
```
public boolean isTreatUnknownFileTypesAsBinary()
```
    Should unknown file types be treated as binary files.
    
    Returns:
    treat unknown file types as binary files
  - getConfigDir
```
public java.io.File getConfigDir()
```
    Returns the directory for configuration options.
    
    Returns:
    configuration directory
  - isProcessBinary
```
public boolean isProcessBinary()
```
    If this flag is set to true, binary files will be processed in replace operations like any others. Otherwise binary files will be treated as read only if it comes to replace operations.
    
    Returns:
    true if binary files should be processed in replace operations
  - setProcessBinary
```
public void setProcessBinary(boolean processBinary)
```
    Sets the process binary files flag.
    
    Parameters:
    processBinary - true if binary files should be processed in replace operations
  - setCharsetList
```
protected void setCharsetList(java.util.List<java.nio.charset.Charset> charsetList)
```
    Sets the list of available character sets.
    
    Parameters:
    charsetList - available character sets
  - setBackupDirectory
```
public final void setBackupDirectory(java.io.File backupDirectory)
```
    Sets the default backup directory. If the specified directory does not exist, the call will be ignored.
    
    Parameters:
    backupDirectory - default backup directory.
  - setBaseDirectory
```
public final void setBaseDirectory(java.io.File baseDir)
```
    Sets the default base directory. If the specified directory does not exist, the call will be ignored.
    
    Parameters:
    baseDir - default base directory.
  - setFileListExportDirectory
```
public final void setFileListExportDirectory(java.io.File exportDir)
```
    Sets the default directory for file list import and export. If the specified directory does not exist, the call will be ignored.
    
    Parameters:
    exportDir - default directory for file list import and export
  - loadFromProperties
```
protected void loadFromProperties(java.util.Properties properties)
```
    Loads the base and the backupd directory from a Properties object. The property names are defined as constants of this class. The property values are supposed to be valid pathes, but both directories are controlled for existance. Inheriting classes may overwrite this method to load additional properties.
    
    Parameters:
    properties - holding properties for base and backup directory.
  - writeToProperties
```
protected void writeToProperties(java.util.Properties properties)
```
    The inverse operation to loadFromProperties().
    
    Parameters:
    properties - where to write base and backup directory to
  - setPatternList
```
protected void setPatternList(java.util.List<FileNamePattern> fileNamepattern)
```
    Sets the file name pattern list.
    
    Parameters:
    fileNamepattern - file name pattern list
  - getFileNamePatternList
```
protected java.util.List<FileNamePattern> getFileNamePatternList()
```
  - setTreatUnknownFileTypesAsBinary
```
public void setTreatUnknownFileTypesAsBinary(boolean treatUnknwonFileTypesAsBinary)
```
    Should unknown file type be treated as binary files.
    
    Parameters:
    treatUnknwonFileTypesAsBinary - treat unknown file types as binary files
  - setConfigDir
```
protected void setConfigDir(java.io.File dir)
```
    Sets the directory for configuration options.
    
    Parameters:
    dir - configuration directory

Class FARConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_JAVA_MINOR_VERSION

APPLICATION_NAME

APPLICATION_TITLE

PPT_BASEDIR

PPT_BCKPDIR

PPT_LISTEXDIR

PPT_GROUPREF

PPT_VERSION

PPT_BINARY

PPT_UNKNOWN_AS_BINARY

GROUPREFINDICATORLIST

STANDARD_DATE_TIME_FORMAT

STANDARD_DATE_FORMAT

STANDARD_TIME_FORMAT

logger

Constructor Detail

FARConfig

Method Detail

getEffectiveJavaVersion

getBaseDirectory

getLocalizer

setLocalizer

getFileNamePatternListModel

getBackupDirectory

getCharsetList

getDefaultCharset

setDefaultCharset

getFileListExportDirectory

getGroupReferenceIndicator

setGroupReferenceIndicator

getDefaultFindForm

getDefaultReplaceForm

getDefaultRenameForm

getDefaultExtractForm

versionHasChanged

isTreatUnknownFileTypesAsBinary

getConfigDir

isProcessBinary

setProcessBinary

setCharsetList

setBackupDirectory

setBaseDirectory

setFileListExportDirectory

loadFromProperties

writeToProperties

setPatternList

getFileNamePatternList

setTreatUnknownFileTypesAsBinary

setConfigDir