org.unix4j.line

Class SimpleLine

java.lang.Object

org.unix4j.line.SimpleLine

All Implemented Interfaces:

CharSequence, Line

public class SimpleLine
extends Object
implements Line

A Line implementation based on two CharSequence's, usually two strings one for the contents and one for the line ending characters.

As opposed to this implementation, the SingleCharSequenceLine consists of a single character sequence for both the content string and the line ending.

Field Summary

Fields inherited from interface org.unix4j.line.Line

CR, EMPTY_LINE, LF, LINE_ENDING, ZERO

Constructor Summary

Constructors

Constructor and Description
SimpleLine(CharSequence content) Constructor with contents and default operating system dependent line ending as defined by Line.LINE_ENDING.
SimpleLine(CharSequence content, char lineEnding) Constructor with contents and lineEnding character sequences.
SimpleLine(CharSequence content, CharSequence lineEnding) Constructor with contents and lineEnding character sequences.

Method Summary

Methods

Modifier and Type	Method and Description
char	charAt(int index)
boolean	equals(Object obj) Compares this line with obj and returns true if obj is a Line (any subclass) and both lines are identical.
String	getContent() Returns the contents making up this line, but without the line ending characters.
int	getContentLength() Returns the length of the content string returned by Line.getContent(), which is zero for a line without content and positive otherwise.
String	getLineEnding() Returns the line ending characters, usually one or two characters such as "\n" or "\r\n".
int	getLineEndingLength() Returns the length of the line ending string returned by Line.getLineEnding(), which is usually one or two and sometimes zero the last line in a file is not terminated with a new line character.
int	hashCode() The hash code for this line, based on the complete line with line ending.
int	length()
static Line	subLine(Line line, int start, int end, boolean preserveLineEnding) Returns a sub-line of the given line, similar to a substring or the method subSequence(int, int).
CharSequence	subSequence(int start, int end)
String	toString() Returns this line including the line ending characters as a string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleLine

public SimpleLine(CharSequence content)

Constructor with contents and default operating system dependent line ending as defined by Line.LINE_ENDING.

Parameters:

content - the character sequence containing the content data of the line

Throws:

NullPointerException - if content is null

See Also:

Line.LINE_ENDING

SimpleLine

public SimpleLine(CharSequence content,
          char lineEnding)

Constructor with contents and lineEnding character sequences.

Parameters:

content - the character sequence containing the content data of the line

lineEnding - a single line ending character

Throws:

IllegalArgumentException - if lineEnding contains more than two characters

NullPointerException - if content or LineEvent is null

SimpleLine

public SimpleLine(CharSequence content,
          CharSequence lineEnding)

Constructor with contents and lineEnding character sequences.

Parameters:

content - the character sequence containing the content data of the line

lineEnding - the character sequence containing the line ending characters, must have length zero, one or two

Throws:

IllegalArgumentException - if lineEnding contains more than two characters

NullPointerException - if content or LineEvent is null

Method Detail

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                       int end)

Specified by:

subSequence in interface CharSequence

getContent

public String getContent()

Description copied from interface: Line

Returns the contents making up this line, but without the line ending characters. Returns an empty string if the line consists only of line ending characters.

Specified by:

getContent in interface Line

Returns:

the line contents without line ending characters; can be an empty string but never null

getContentLength

public int getContentLength()

Description copied from interface: Line

Returns the length of the content string returned by Line.getContent(), which is zero for a line without content and positive otherwise.

Specified by:

getContentLength in interface Line

Returns:

the non-negative length of the content string returned by Line.getContent()

getLineEnding

public String getLineEnding()

Description copied from interface: Line

Returns the line ending characters, usually one or two characters such as "\n" or "\r\n". If the last line in a file is not terminated with a new line character, the returned string can have zero length.

The encoding of line endings depends on the source of this line object. It is a single line feed character (LF="\n") if the source is a Unix type file, and carriage return followed by line feed (CR+LF= "\r\n") for lines from a Windows file.

Specified by:

getLineEnding in interface Line

Returns:

the line ending characters, usually a one or two character string and sometimes empty for the last line

getLineEndingLength

public int getLineEndingLength()

Description copied from interface: Line

Returns the length of the line ending string returned by Line.getLineEnding(), which is usually one or two and sometimes zero the last line in a file is not terminated with a new line character.

Specified by:

getLineEndingLength in interface Line

Returns:

the length of the line ending string, usually one or two and sometimes zero for the last line

toString

public String toString()

Description copied from interface: Line

Returns this line including the line ending characters as a string.

Specified by:

toString in interface CharSequence

Specified by:

toString in interface Line

Overrides:

toString in class Object

Returns:

the line with line ending

hashCode

public int hashCode()

Description copied from interface: Line

The hash code for this line, based on the complete line with line ending.

Specified by:

hashCode in interface Line

Overrides:

hashCode in class Object

Returns:

the hash code based on content and line ending

equals

public boolean equals(Object obj)

Description copied from interface: Line

Compares this line with obj and returns true if obj is a Line (any subclass) and both lines are identical. The line comparison considers both the content and the line ending.

Specified by:

equals in interface Line

Overrides:

equals in class Object

Parameters:

obj - the object to be compared with

Returns:

true if obj is a Line identical to this Line also considering the line ending when comparing the lines

subLine

public static Line subLine(Line line,
           int start,
           int end,
           boolean preserveLineEnding)

Returns a sub-line of the given line, similar to a substring or the method subSequence(int, int). The difference is that the result is again a proper line, with or without line ending depending on the cutting point and the preserveLineEnding flag.

Parameters:

line - the line to cut

start - the start index (inclusive), valid from 0 to end

end - the end index (exclusive), valid from 0 to line.length() if preserveLineEnding=false, and from 0 to line.getContentLength() if preserveLineEnding=true

preserveLineEnding - if true, the line's ending is preserved and copied to the returned line (only the content of the line is cut in this case)

Returns:

a new line representing a sub-line of the input line