logahawk.formatters
Class StringArgFormatter

java.lang.Object
  logahawk.formatters.StringArgFormatter

All Implemented Interfaces:

ArgumentFormatter

@Immutable
public class StringArgFormatter
extends Object
implements ArgumentFormatter

This formatter can handle CharSequence and Character objects, including String, StringBuilder, and StringBuffer.

Constructor Summary

StringArgFormatter()

Method Summary

boolean	canFormat(Object obj) This should return true only if this can provide a useful formatting for this type of object.
String	format(Object obj, Collection<ArgumentFormatter> formatters, int indentLevel) This converts the object into a String that represent the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringArgFormatter

public StringArgFormatter()

Method Detail

canFormat

public boolean canFormat(Object obj)

Description copied from interface: ArgumentFormatter

This should return true only if this can provide a useful formatting for this type of object.

Specified by:

canFormat in interface ArgumentFormatter

format

public String format(Object obj,
                     Collection<ArgumentFormatter> formatters,
                     int indentLevel)

Description copied from interface: ArgumentFormatter

This converts the object into a String that represent the object. The String may contain line breaks, but should not include a trailing line break. The first line of the result should NOT include any indentation, that should be handled by the calling class. If the object is complex and contains other objects, this ArgumentFormatter may use the provided list of ArgumentFormatter objects to find a more appropriate formatter. To make things look nice, the "indentLevel" is provided. The indent level should always be incremented by one when calling downward into other ArgumentFormatters.

Specified by:

format in interface ArgumentFormatter