asia.redact.bracket.properties.line

Class Line

java.lang.Object

asia.redact.bracket.properties.line.Line

All Implemented Interfaces:

Serializable

public class Line
extends Object
implements Serializable

Representation of a line of text in a properties file. Index is the absolute offset of this line in the file at the time it was read. The line end is not included in "text", it is found in the "ending" variable.

This class is thread-safe.

Author:

Dave

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) LineEnding	ending
(package private) long	index
private static long	serialVersionUID
(package private) String	text

Constructor Summary

Constructors

Constructor and Description
Line(String text, long index, LineEnding ending)

Method Summary

Modifier and Type	Method and Description
String	commentContents()
boolean	equals(Object obj)
LineEnding	getEnding()
long	getIndex()
String	getText()
boolean	hasContinuation() Return true if this line is a value extension of a line (part of a logical line)
int	hashCode()
boolean	isCommentLine()
boolean	isEmptyLine()
boolean	isNaturalLine() Natural lines contain keys, a delimiter, and a value (or initial value part)
boolean	isPrivateComment() Used to identify our private (transient) comment system for a comment header
String	logicalLineContents()
String[]	naturalLineContents()
private PropertiesToken	nominalEnding()
List<PropertiesToken>	tokens() Tokenize a line of text from a properties file.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

text

final String text

index

final long index

ending

final LineEnding ending

Constructor Detail

Line

public Line(String text,
            long index,
            LineEnding ending)

Method Detail

tokens

public List<PropertiesToken> tokens()

Tokenize a line of text from a properties file.

Returns:

hasContinuation

public boolean hasContinuation()

Return true if this line is a value extension of a line (part of a logical line)

Returns:

isPrivateComment

public boolean isPrivateComment()

Used to identify our private (transient) comment system for a comment header

Returns:

logicalLineContents

public String logicalLineContents()

isNaturalLine

public boolean isNaturalLine()

Natural lines contain keys, a delimiter, and a value (or initial value part)

Returns:

isCommentLine

public boolean isCommentLine()

isEmptyLine

public boolean isEmptyLine()

commentContents

public String commentContents()

naturalLineContents

public String[] naturalLineContents()

getText

public String getText()

getIndex

public long getIndex()

getEnding

public LineEnding getEnding()

nominalEnding

private PropertiesToken nominalEnding()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object