org.dmd.util.formatting

Class CodeFormatter

java.lang.Object

org.dmd.util.formatting.CodeFormatter

public class CodeFormatter
extends Object

The CodeFormatter class contains a variety of static utility methods that are useful when dumping code.

Constructor Summary

Constructors

Constructor and Description
CodeFormatter()

Method Summary

Modifier and Type	Method and Description
static void	dumpCodeComment(Iterator<String> description, BufferedWriter out, String indent)
static void	dumpCodeComment(Iterator<String> description, StringBuffer out, String indent)
static void	dumpCodeComment(String comment, BufferedWriter out, String indent) This function dumps the description of a class as a code comment.
static void	dumpCodeComment(String comment, StringBuffer out, String indent) This function dumps the description of a class as a code comment.
static String	foldFullyQualified(String fullyQualified, int maxLength) Splits a fully qualified class name at dot boundaries up to the maxLength.
static String	getTheClass(String fullyQualified) Takes a fully qualified class name and returns just the class name portion.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeFormatter

public CodeFormatter()

Method Detail

dumpCodeComment

public static void dumpCodeComment(String comment,
                                   BufferedWriter out,
                                   String indent)
                            throws IOException

This function dumps the description of a class as a code comment. Long lines are folded to 75 characters.

Parameters:

comment - The comment to be written

out - The output buffer.

indent - The indent string.

Throws:

IOException

dumpCodeComment

public static void dumpCodeComment(String comment,
                                   StringBuffer out,
                                   String indent)

This function dumps the description of a class as a code comment. Long lines are folded to 75 characters.

Parameters:

comment - The comment to be written

out - The output buffer.

indent - The indent string.

Throws:

IOException

getTheClass

public static String getTheClass(String fullyQualified)

Takes a fully qualified class name and returns just the class name portion.

Parameters:

fullyQualified -

Returns:

Just the class name.

foldFullyQualified

public static String foldFullyQualified(String fullyQualified,
                                        int maxLength)

Splits a fully qualified class name at dot boundaries up to the maxLength.

Parameters:

fullyQualified -

maxLength -

Returns:

the folded string with line breaks near the max length

dumpCodeComment

public static void dumpCodeComment(Iterator<String> description,
                                   StringBuffer out,
                                   String indent)

dumpCodeComment

public static void dumpCodeComment(Iterator<String> description,
                                   BufferedWriter out,
                                   String indent)
                            throws IOException

Throws:

IOException