org.exolab.javasource.LineFormatter Class Reference

List of all members.

Package Functions
	LineFormatter (String comment)
	LineFormatter (String comment, int maxLength)
	LineFormatter (String comment, int maxLength, String prefix)
boolean	hasMoreLines ()
String	nextLine ()
void	setPrefix (String prefix)
Package Attributes
String	comment = null
int	maxLength = 65
int	offset = 0
int	length = 0
String	prefix = null

---

Detailed Description

Formats a given String for use within a Java comment

Author:

Keith Visco

---

Constructor & Destructor Documentation

org.exolab.javasource.LineFormatter.LineFormatter

(

String

comment

)

[package]

Creates a LineFormatter for the given comment

Parameters:

comment

the String to format

References org.exolab.javasource.LineFormatter.length.

org.exolab.javasource.LineFormatter.LineFormatter	(	String	comment,
		int	maxLength
	)			[package]

Creates a new LineFormatter for the given comment

Parameters:

	comment	the String to format
	maxLength	the maximum number of characters per line

org.exolab.javasource.LineFormatter.LineFormatter	(	String	comment,
		int	maxLength,
		String	prefix
	)			[package]

Creates a new LineFormatter for the given comment

Parameters:

	comment	the String to format
	maxLength	the maximum number of characters per line
	prefix	a prefix to append to the beginning of each line

---

Member Function Documentation

boolean org.exolab.javasource.LineFormatter.hasMoreLines

(

)

[package]

References org.exolab.javasource.LineFormatter.comment, org.exolab.javasource.LineFormatter.length, and org.exolab.javasource.LineFormatter.offset.

Referenced by org.exolab.javasource.JComment.print().

String org.exolab.javasource.LineFormatter.nextLine

(

)

[package]

References org.exolab.javasource.LineFormatter.comment, org.exolab.javasource.LineFormatter.length, org.exolab.javasource.LineFormatter.maxLength, org.exolab.javasource.LineFormatter.offset, and org.exolab.javasource.LineFormatter.prefix.

Referenced by org.exolab.javasource.JComment.print().

void org.exolab.javasource.LineFormatter.setPrefix

(

String

prefix

)

[package]

Sets the prefix that should be appended to the beginning of each line

Parameters:

prefix

the prefix for this LineFormatter

---

Member Data Documentation

String org.exolab.javasource.LineFormatter.comment = null [package]

Referenced by org.exolab.javasource.LineFormatter.hasMoreLines(), and org.exolab.javasource.LineFormatter.nextLine().

int org.exolab.javasource.LineFormatter.length = 0 [package]

Referenced by org.exolab.javasource.LineFormatter.hasMoreLines(), org.exolab.javasource.LineFormatter.LineFormatter(), and org.exolab.javasource.LineFormatter.nextLine().

int org.exolab.javasource.LineFormatter.maxLength = 65 [package]

Referenced by org.exolab.javasource.LineFormatter.nextLine().

int org.exolab.javasource.LineFormatter.offset = 0 [package]

Referenced by org.exolab.javasource.LineFormatter.hasMoreLines(), and org.exolab.javasource.LineFormatter.nextLine().

String org.exolab.javasource.LineFormatter.prefix = null [package]

Referenced by org.exolab.javasource.LineFormatter.nextLine().

---

The documentation for this class was generated from the following file:

• JComment.java