Annotation Interface ToString


@Beta @Target(TYPE) @GwtCompatible public @interface ToString
Creates a default toString implementation.

All non-static fields of this class and all of its superclasses are used. Reflection is used to access all fields if this class has a superclass. This may not work in restrictive environments. For such cases use ToStringBuilder to write a non-reflective implementation.

The default format is:
  ClassName [
    field1 = "Foo"
    field2 = 2
    field3 = null
  ]
 
The class name is hardcoded. Subclasses which inherit this class without overriding toString will show the same name.

For brevity there are options to hide field names, skip fields with null values and print everything on one line.

Since:
2.7
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    Only list the values of the fields, not their names
    boolean
    Seperate fields with a comma and a single space
    boolean
    Fields with null values are not shown in the output.
    boolean
    By default, Iterables, Arrays and multiline Strings are pretty-printed.
  • Element Details

    • skipNulls

      boolean skipNulls
      Fields with null values are not shown in the output.
      Default:
      false
    • singleLine

      boolean singleLine
      Seperate fields with a comma and a single space
      Default:
      false
    • hideFieldNames

      boolean hideFieldNames
      Only list the values of the fields, not their names
      Default:
      false
    • verbatimValues

      boolean verbatimValues
      By default, Iterables, Arrays and multiline Strings are pretty-printed. Switching to their normal representation makes the toString method significantly faster.
      Since:
      2.9
      Default:
      false