flux.file
Interface Renamer

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

public interface Renamer
extends java.lang.Cloneable, java.io.Serializable

Using a pre-defined renamer or substitution algorithm, returns an output string based on the input string and the renamer substitution algorithm. For more information on using the global and regular expression renamers, see the "File Triggers and Action" section in the Flux wikidoc.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.lang.Object	clone()
java.lang.String	getFromPattern() Returns the "from" pattern.
java.lang.String	getToPattern() Returns the "to" pattern.
java.lang.String	map(java.lang.String input) Using a pre-defined renamer or substitution algorithm, returns an output string based on the input string and the renamer algorithm.
void	setFromPattern(java.lang.String fromPattern) Sets the "from" pattern.
void	setToPattern(java.lang.String toPattern) Sets the "to" pattern.

Method Detail

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

getFromPattern

java.lang.String getFromPattern()

Returns the "from" pattern.

Returns:

The "from" pattern.

getToPattern

java.lang.String getToPattern()

Returns the "to" pattern.

Returns:

The "to" pattern.

map

java.lang.String map(java.lang.String input)
                     throws FileActionException

Using a pre-defined renamer or substitution algorithm, returns an output string based on the input string and the renamer algorithm.

Parameters:

input - The input string.

Returns:

An output string based on the input string and the renamer algorithm.

Throws:

FileActionException - if anything goes wrong.

setFromPattern

void setFromPattern(java.lang.String fromPattern)

Sets the "from" pattern.

Parameters:

fromPattern - The "from" pattern.

setToPattern

void setToPattern(java.lang.String toPattern)

Sets the "to" pattern.

Parameters:

toPattern - The "to" pattern.