org.arquillian.spacelift.task.text

Class StringReplacementTool

java.lang.Object

org.arquillian.spacelift.task.Task<Object,List<File>>

org.arquillian.spacelift.task.text.StringReplacementTool

public class StringReplacementTool
extends Task<Object,List<File>>

Tool for string replacement inside files. It has no input and outputs list of modified files. To select the files to be processed, use in(File...) or in(String). All the files you select for processing has to be using the same charset. If you wish to replace files with different charsets, you need to use this task multiple times and use charset(Charset) to set the charset of processed files.

Author:

Stefan Miklosovic, Tadeas Kriz

Constructor Summary

Constructors

Constructor and Description
StringReplacementTool()

Method Summary

Methods

Modifier and Type	Method and Description
StringReplacementTool	charset(Charset charset) Selects the charset which will be used for reading and writing the files.
StringReplacementTool	in(File... file) Adds files to the list to be processed by the tool.
StringReplacementTool	in(String file) Adds path as a file to be processed by the tool.
protected List<File>	process(Object input)
ReplacementTuple<StringReplacementTool>	replace(String regex) Set a regular expression to be used for the replacement.

Methods inherited from class org.arquillian.spacelift.task.Task

execute, getExecutionService, run, setExecutionService, setPreviousTask, then, then

Methods inherited from class java.lang.Object

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

Constructor Detail

StringReplacementTool

public StringReplacementTool()

Method Detail

in

public StringReplacementTool in(File... file)

Adds files to the list to be processed by the tool.

Parameters:

file -

Returns:

in

public StringReplacementTool in(String file)

Adds path as a file to be processed by the tool.

Parameters:

file -

Returns:

replace

public ReplacementTuple<StringReplacementTool> replace(String regex)

Set a regular expression to be used for the replacement. You will then be able to specify the replacement string.

NOTE: You can specify multiple replacements and they will all be evaluated when the task is run. The order of their evaluation is the same as you add the replacements into this tool.

charset

public StringReplacementTool charset(Charset charset)

Selects the charset which will be used for reading and writing the files.

process

protected List<File> process(Object input)
                      throws Exception

Specified by:

process in class Task<Object,List<File>>

Throws:

Exception