ToString (groovy 2.4.4 API)

groovy.transform.ToString

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Element Summary

Optional Element Summary
Type	Name and Description
`boolean`	`cache` Whether to cache toString() calculations.
`String[]`	`excludes` List of field and/or property names to exclude from generated toString.
`boolean`	`ignoreNulls` Don't display any fields or properties with value `null`.
`boolean`	`includeFields` Include fields as well as properties in the generated toString.
`boolean`	`includeNames` Whether to include names of properties/fields in the generated toString.
`boolean`	`includePackage` Whether to include the fully-qualified class name (i.e. including the package) or just the simple class name in the generated toString.
`boolean`	`includeSuper` Whether to include the toString() of super in the generated toString.
`boolean`	`includeSuperProperties` Whether to include super properties in the generated toString.
`String[]`	`includes` List of field and/or property names to include within the generated toString.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Element Detail
  - public boolean cache
    
    Whether to cache toString() calculations. You should only set this to true if you know the object is immutable (or technically mutable but never changed). @default false
    Since:
    2.1.0
  - public String[] excludes
    
    List of field and/or property names to exclude from generated toString. Must not be used if 'includes' is used. For convenience, a String with comma separated names can be used in addition to an array (using Groovy's literal list notation) of String values. @default {}
  - public boolean ignoreNulls
    
    Don't display any fields or properties with value null. @default false
  - public boolean includeFields
    
    Include fields as well as properties in the generated toString. @default false
  - public boolean includeNames
    
    Whether to include names of properties/fields in the generated toString. @default false
  - public boolean includePackage
    
    Whether to include the fully-qualified class name (i.e. including the package) or just the simple class name in the generated toString. @default true
    Since:
    2.0.6
  - public boolean includeSuper
    
    Whether to include the toString() of super in the generated toString. @default false
  - public boolean includeSuperProperties
    
    Whether to include super properties in the generated toString. @default false
    Since:
    2.4.0
  - public String[] includes
    
    List of field and/or property names to include within the generated toString. Must not be used if 'excludes' is used. For convenience, a String with comma separated names can be used in addition to an array (using Groovy's literal list notation) of String values. @default {}

Summary:
Optional

| Detail:
Element

[Java] Annotation Type ToString

Element Summary

Inherited Methods Summary

Element Detail

public boolean cache

public String[] excludes

public boolean ignoreNulls

public boolean includeFields

public boolean includeNames

public boolean includePackage

public boolean includeSuper

public boolean includeSuperProperties

public String[] includes