net.sf.jeters.componentInterface
Interface ReplacerComponent<I extends net.sf.jeters.componentInterface.editables.EditableText,O extends net.sf.jeters.componentInterface.editables.EditableText>
- All Superinterfaces:
- Component
- All Known Implementing Classes:
- RegExReplacer, RegExReplacer_User
public interface ReplacerComponent<I extends net.sf.jeters.componentInterface.editables.EditableText,O extends net.sf.jeters.componentInterface.editables.EditableText>
- extends Component
the interface making a class a JETERS-Replacer-component.
This class is generic.
I specifies the required implementation of EditableText
for the input,
O the resulting output.
For details about replacer components and other JETERS concepts read the documentation provided for the project.
- Version:
- [development]
- Author:
- Tobias Knerr
Method Summary |
O[] |
edit(I text,
UIComponent uiForRequests)
performs all replacements to a text (implementation of EditableText as spcified by generic type I)
and returns the resulting text (object of the type O) |
edit
O[] edit(I text,
UIComponent uiForRequests)
- performs all replacements to a text (implementation of
EditableText
as spcified by generic type I)
and returns the resulting text (object of the type O)
- Parameters:
text
- the input text that is supposed to be editeduiForRequests
- UI-component for communication with the user.
(Most probably you'll want to use the confirmChanges-method when implementing edit,
see description at UIComponent
.)
- Returns:
- array of texts resulting from the editing process, null indicates cancelling.
while most Replacers will only provide a single text per edit-call, some might need to provide more than that
(e.g. modifying a page and its discussion page at the same time).