org.jomc.util
Class LineEditor

Package class diagram package LineEditor
java.lang.Object
  extended by org.jomc.util.LineEditor
Direct Known Subclasses:
SectionEditor, TrailingWhitespaceEditor

public class LineEditor
extends Object

Interface to line based editing.

Version:
$Id: LineEditor.java 891 2009-11-02 03:40:00Z schulte2005 $
Author:
Christian Schulte
See Also:
edit(java.lang.String)

Constructor Summary
LineEditor()
          Creates a new LineEditor instance.
LineEditor(LineEditor editor)
          Creates a new LineEditor instance taking an editor to chain.
LineEditor(LineEditor editor, String lineSeparator)
          Creates a new LineEditor instance taking an editor to chain and a string to use for separating lines.
LineEditor(String lineSeparator)
          Creates a new LineEditor instance taking a string to use for separating lines.
 
Method Summary
 String edit(String text)
          Edits text.
protected  String editLine(String line)
          Edits a line.
 String getLineSeparator()
          Gets the line separator of the editor.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LineEditor

public LineEditor()
Creates a new LineEditor instance.


LineEditor

public LineEditor(String lineSeparator)
Creates a new LineEditor instance taking a string to use for separating lines.

Parameters:
lineSeparator - String to use for separating lines.

LineEditor

public LineEditor(LineEditor editor)
Creates a new LineEditor instance taking an editor to chain.

Parameters:
editor - The editor to chain.

LineEditor

public LineEditor(LineEditor editor,
                  String lineSeparator)
Creates a new LineEditor instance taking an editor to chain and a string to use for separating lines.

Parameters:
editor - The editor to chain.
lineSeparator - String to use for separating lines.
Method Detail

getLineSeparator

public final String getLineSeparator()
Gets the line separator of the editor.

Returns:
The line separator of the editor.

edit

public final String edit(String text)
                  throws IOException
Edits text.

This method splits the given string into lines and passes every line to method editLine in order of occurrence. On end of input, method editLine is called with a null argument.

Parameters:
text - The text to edit or null.
Returns:
The edited text or null.
Throws:
IOException - if editing fails.

editLine

protected String editLine(String line)
                   throws IOException
Edits a line.

Parameters:
line - The line to edit or null indicating the end of input.
Returns:
The string to replace line with, or null to replace line with nothing.
Throws:
IOException - if editing fails.


Copyright © 2005-2009 The JOMC Project. All Rights Reserved.