net.pandoragames.far.ui

Interface ReplacementDescriptor

All Superinterfaces:

java.lang.Cloneable, ContentFilter

All Known Implementing Classes:

ReplaceForm

public interface ReplacementDescriptor
extends ContentFilter

Data for a replacement operation.

Author:

Olivier Wehner

Method Summary

Methods

Modifier and Type	Method and Description
ReplacementDescriptor	clone() Returns a copy of this object, with all interface method behaving exactly as the original instance.
java.io.File	getBackupDirectory() Returns the backup directory.
java.io.File	getBaseDirectory() Returns the base directory, if any.
ReplacementString	getReplacementPattern(java.lang.String lineBreak) Returns the replacement string as a ReplacementString object.
java.lang.String	getReplacementString() Returns the raw replacement string as specified by the user.
boolean	isDoBackup() Returns the doBackup flag.

Methods inherited from interface net.pandoragames.far.ui.ContentFilter

getContentPatternAsRegex, getSearchStringContent

Method Detail

isDoBackup

boolean isDoBackup()

Returns the doBackup flag. Note that the application may choose to create temporary backups, even if this flag is set to false, in order to allow undo operations.

Returns:

whether backups should be created or not

See Also:

FileMatcher.isDoBackup()

getBackupDirectory

java.io.File getBackupDirectory()

Returns the backup directory.

Returns:

backup directory if any

See Also:

FileMatcher.setBackUpDirectory(File)

getReplacementString

java.lang.String getReplacementString()

Returns the raw replacement string as specified by the user.

Returns:

replacement string, possibly empty, never null

getReplacementPattern

ReplacementString getReplacementPattern(java.lang.String lineBreak)

Returns the replacement string as a ReplacementString object.

Parameters:

lineBreak - the lineBreak to be used, if null the system dependent line separator will be used

Returns:

ReplacementString object or null if no replacement is defined.

getBaseDirectory

java.io.File getBaseDirectory()

Returns the base directory, if any. This attribute is used for the creation of back ups. All files subject to a replacement operation should share the same common base directory. Alternatively, this attribute should be set to null, or the doBackup flag should be set to false.

Returns:

base directory for the resolution of relative pathes during backup operations.

See Also:

FileMatcher.setBaseDirectory(File)

clone

ReplacementDescriptor clone()

Returns a copy of this object, with all interface method behaving exactly as the original instance.

Specified by:

clone in interface ContentFilter

Returns:

copy of this object.