logahawk.formatters
Class DefaultArgFormatter

java.lang.Object
  logahawk.formatters.DefaultArgFormatter

All Implemented Interfaces:

ArgumentFormatter

@Immutable
public class DefaultArgFormatter
extends Object
implements ArgumentFormatter

Provides basic information about any object, specifically the Class, hashcode, and results of toString(). This, along with NullArgFormatter, should always be added to any ArgumentFormatterContainer.

Constructor Summary

DefaultArgFormatter()

Method Summary

boolean	canFormat(Object obj) Returns true only if the object is not null.
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

DefaultArgFormatter

public DefaultArgFormatter()

Method Detail

canFormat

public boolean canFormat(Object obj)

Returns true only if the object is not null.

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