lombok

Annotation Type ToString

@Target(value=TYPE)
 @Retention(value=SOURCE)
public @interface ToString

Generates an implementation for the toString method inherited by all objects, consisting of printing the values of relevant fields.

Complete documentation is found at the project lombok features page for @ToString.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	callSuper Include the result of the superclass's implementation of toString in the output.
boolean	doNotUseGetters Normally, if getters are available, those are called.
String[]	exclude Any fields listed here will not be printed in the generated toString implementation.
boolean	includeFieldNames Include the name of each field when printing it.
String[]	of If present, explicitly lists the fields that are to be printed.
boolean	onlyExplicitlyIncluded Only include fields and methods explicitly marked with @ToString.Include.

Element Detail

includeFieldNames

public abstract boolean includeFieldNames

Include the name of each field when printing it. default: true

Returns:

Whether or not to include the names of fields in the string produced by the generated toString().

Default:

true

exclude

public abstract String[] exclude

Any fields listed here will not be printed in the generated toString implementation. Mutually exclusive with of().

Will soon be marked @Deprecated; use the @ToString.Exclude annotation instead.

Returns:

A list of fields to exclude.

Default:

{}

of

public abstract String[] of

If present, explicitly lists the fields that are to be printed. Normally, all non-static fields are printed.

Mutually exclusive with exclude().

Will soon be marked @Deprecated; use the @ToString.Include annotation together with @ToString(onlyExplicitlyIncluded = true).

Returns:

A list of fields to use (default: all of them).

Default:

{}

callSuper

public abstract boolean callSuper

Include the result of the superclass's implementation of toString in the output. default: false

Returns:

Whether to call the superclass's toString implementation as part of the generated toString algorithm.

Default:

false

doNotUseGetters

public abstract boolean doNotUseGetters

Normally, if getters are available, those are called. To suppress this and let the generated code use the fields directly, set this to true. default: false

Returns:

If true, always use direct field access instead of calling the getter method.

Default:

false

onlyExplicitlyIncluded

public abstract boolean onlyExplicitlyIncluded

Only include fields and methods explicitly marked with @ToString.Include. Normally, all (non-static) fields are included by default.

Default:

false