Package com.tngtech.jgiven.format

Class DefaultFormatter<T>

java.lang.Object

com.tngtech.jgiven.format.DefaultFormatter<T>

All Implemented Interfaces:

ArgumentFormatter<T>, Formatter<T>, ObjectFormatter<T>

Direct Known Subclasses:

DefaultObjectFormatter

public class DefaultFormatter<T>
extends java.lang.Object
implements ArgumentFormatter<T>, Formatter<T>, ObjectFormatter<T>

A default formatter that merely use String.valueOf(Object), except for arrays where Arrays.deepToString(Object[]) is used.

Field Summary

Fields

Modifier and Type	Field	Description
static DefaultFormatter	INSTANCE

Constructor Summary

Constructors

Constructor	Description
DefaultFormatter()

Method Summary

Modifier and Type	Method	Description
java.lang.String	format(T argumentToFormat)
java.lang.String	format(T argumentToFormat, java.lang.annotation.Annotation... annotations)	Formats a step method argument.
java.lang.String	format(T argumentToFormat, java.lang.String... formatterArguments)	Format a single argument by taking optional formatter arguments into account.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final DefaultFormatter INSTANCE

Constructor Detail

DefaultFormatter

public DefaultFormatter()

Method Detail

format

@Nonnull
public java.lang.String format(@Nullable
                               T argumentToFormat,
                               @Nullable
                               java.lang.String... formatterArguments)

Description copied from interface: ArgumentFormatter

Format a single argument by taking optional formatter arguments into account.

Specified by:

format in interface ArgumentFormatter<T>

Parameters:

argumentToFormat - the object to format

formatterArguments - optional arguments for the formatter to control the formatting.

Returns:

a formatted string

format

@Nonnull
public java.lang.String format(@Nullable
                               T argumentToFormat,
                               @Nullable
                               java.lang.annotation.Annotation... annotations)

Description copied from interface: Formatter

Formats a step method argument.

Specified by:

format in interface Formatter<T>

Parameters:

argumentToFormat - the argument object to format

annotations - list of annotations that the method parameter is annotated with

Returns:

a formatted string

format

@Nonnull
public java.lang.String format(@Nullable
                               T argumentToFormat)

Specified by:

format in interface ObjectFormatter<T>