nl.taico.configplus

Class Comment

java.lang.Object

nl.taico.configplus.Comment

All Implemented Interfaces:

CharSequence

public class Comment
extends Object
implements CharSequence

Constructor Summary

Constructors

Constructor and Description
Comment(String value) If value == null, this comment is set to "" (an empty line).

Method Summary

Methods

Modifier and Type	Method and Description
char	charAt(int index)
String	getComment()
String	getLine()
int	length()
void	setComment(String value) If value == null, this comment is set to "" (an empty line). If value does not start with a # (spaces are ignored), this comment is set to # + value. Otherwise, this comment is set to the given value.
CharSequence	subSequence(int start, int end)
Line	toLine()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Comment

public Comment(String value)

If value == null, this comment is set to "" (an empty line).

Parameters:

value -

Method Detail

getLine

public String getLine()

Returns:

The value of this comment as it should appear in the config file.

toLine

public Line toLine()

Returns:

A CommentLine with this comment or an EmptyLine if this Comment indicates an empty line.

getComment

public String getComment()

Returns:

The comment message, without the # and with leading/trailing whitespace removed.

setComment

public void setComment(String value)

If value == null, this comment is set to "" (an empty line).
If value does not start with a # (spaces are ignored), this comment is set to # + value.
Otherwise, this comment is set to the given value.

Parameters:

value -

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

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object