Class ModifyMultipleTextFiles
- java.lang.Object
-
- com.zerog.ia.auto.project.ProjectObject
-
- com.zerog.ia.auto.project.InstallableObject
-
- com.zerog.ia.auto.project.actions.Action
-
- com.zerog.ia.auto.project.actions.ModifyMultipleTextFiles
-
- All Implemented Interfaces:
DBHostable
,GeneralAction
,JEEHostable
,OSHostable
,Referenceable
public final class ModifyMultipleTextFiles extends Action implements GeneralAction
Alters several text files on the target system. Use this action any time you need to make the same changes to multiple text files within the same directory.
-
-
Constructor Summary
Constructors Constructor Description ModifyMultipleTextFiles()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAdditionalText()
The additional text to use when performing the defined operation.boolean
getBackup()
Whether to create a backup of the file prior to modification.java.lang.String
getExistingFile()
The existing file path the action should point to.boolean
getIgnoreUnknownIAVariables()
Whether to ignore unknown IA variables in the file.FileAction
getInstalledFile()
The installed file the action should point to.LineEnding
getLineEndings()
The line ending to use.FilterPatternMatcher
getPatternMatcher()
The filters to use when searching files in the specified directory.java.util.Vector<KeyedData>
getSearchAndReplaceStrings()
The list of strings to search and replace.boolean
getSubstituteIAVariables()
Whether to substitute the IA variables in the files.TextOperation
getTextOperation()
The text operation to perform.boolean
getUseInstalledFile()
Whether to use an installed file instead of an existing file.void
setAdditionalText(java.lang.String additionalText)
The additional text to use when performing the defined operation.void
setBackup(boolean backup)
Whether to create a backup of the file prior to modification.void
setExistingFile(java.lang.String existingFilePath)
The existing file path the action should point to.void
setIgnoreUnknownIAVariables(boolean ignoreUnknownIAVariables)
Whether to ignore unknown IA variables in the file.void
setInstalledFile(FileAction file)
The installed file the action should point to.void
setLineEndings(LineEnding lineEndings)
The line ending to use.void
setSearchAndReplaceStrings(java.util.Vector<KeyedData> searchReplaceStrings)
The list of strings to search and replace.void
setSubstituteIAVariables(boolean substitute)
Whether to substitute the IA variables in the files.void
setTextOperation(TextOperation textOperation)
The text operation to perform.void
setUseInstalledFile(boolean useInstalledFile)
Whether to use an installed file instead of an existing file.-
Methods inherited from class com.zerog.ia.auto.project.InstallableObject
getBelongsToUninstallPhase, getRollbackEnabledCancel, getRollbackEnabledError, getRuleExpression, getRules, getRulesLogicalOperation, getTagsInInstallPiece, setBelongsToUninstallPhase, setRollbackEnabledCancel, setRollbackEnabledError, setRuleExpression, setRulesLogicalOperation, setTagsInInstallPiece
-
Methods inherited from class com.zerog.ia.auto.project.ProjectObject
equals, getReferenceID, hashCode, setReferenceID
-
-
-
-
Method Detail
-
setAdditionalText
public void setAdditionalText(java.lang.String additionalText)
The additional text to use when performing the defined operation.
-
getAdditionalText
public java.lang.String getAdditionalText()
The additional text to use when performing the defined operation.
-
setLineEndings
public void setLineEndings(LineEnding lineEndings)
The line ending to use.
-
getLineEndings
public LineEnding getLineEndings()
The line ending to use.
-
setTextOperation
public void setTextOperation(TextOperation textOperation)
The text operation to perform.
-
getTextOperation
public TextOperation getTextOperation()
The text operation to perform.
-
setInstalledFile
public void setInstalledFile(FileAction file)
The installed file the action should point to. To use this option the useInstalledFile property should be set to true.- See Also:
setUseInstalledFile(boolean)
-
getInstalledFile
public FileAction getInstalledFile()
The installed file the action should point to.
-
setExistingFile
public void setExistingFile(java.lang.String existingFilePath)
The existing file path the action should point to. To use this option the useInstalledFile property should be set to false.- See Also:
setUseInstalledFile(boolean)
-
getExistingFile
public java.lang.String getExistingFile()
The existing file path the action should point to.
-
setSubstituteIAVariables
public void setSubstituteIAVariables(boolean substitute)
Whether to substitute the IA variables in the files.
-
getSubstituteIAVariables
public boolean getSubstituteIAVariables()
Whether to substitute the IA variables in the files.
-
setIgnoreUnknownIAVariables
public void setIgnoreUnknownIAVariables(boolean ignoreUnknownIAVariables)
Whether to ignore unknown IA variables in the file.
-
getIgnoreUnknownIAVariables
public boolean getIgnoreUnknownIAVariables()
Whether to ignore unknown IA variables in the file.
-
setBackup
public void setBackup(boolean backup)
Whether to create a backup of the file prior to modification. (The backup file name is determined by adding .backup to the original file name.) Backup files are not removed by the uninstaller.
-
getBackup
public boolean getBackup()
Whether to create a backup of the file prior to modification. (The backup file name is determined by adding .backup to the original file name.) Backup files are not removed by the uninstaller.
-
setUseInstalledFile
public void setUseInstalledFile(boolean useInstalledFile)
Whether to use an installed file instead of an existing file.
-
getUseInstalledFile
public boolean getUseInstalledFile()
Whether to use an installed file instead of an existing file.
-
setSearchAndReplaceStrings
public void setSearchAndReplaceStrings(java.util.Vector<KeyedData> searchReplaceStrings)
The list of strings to search and replace. Expects aVector
ofKeyedData
where the propertyName is the string to search for and the propertyValue is the string to replace with.
-
getSearchAndReplaceStrings
public java.util.Vector<KeyedData> getSearchAndReplaceStrings()
The list of strings to search and replace.
-
getPatternMatcher
public FilterPatternMatcher getPatternMatcher()
The filters to use when searching files in the specified directory.
-
-