GridToStringBuilder (Ignite 2.15.0)

java.lang.Object
- org.apache.ignite.internal.util.tostring.GridToStringBuilder

Direct Known Subclasses:

S
```
public class GridToStringBuilder
extends Object
```
Provides auto-generation framework for toString() output.
In case of recursion, repeatable objects will be shown as "ClassName@hash". But fields will be printed only for the first entry to prevent recursion.
Default exclusion policy (can be overridden with GridToStringInclude annotation):
- fields with GridToStringExclude annotations
- classes that have GridToStringExclude annotation (current list):
  - GridManager
  - GridManagerRegistry
  - GridProcessor
  - GridProcessorRegistry
  - IgniteLogger
  - GridDiscoveryMetricsProvider
  - GridByteArrayList
- static fields
- non-private fields
- arrays
- fields of type Object
- fields of type Thread
- fields of type Runnable
- fields of type Serializable
- fields of type Externalizable
- InputStream implementations
- OutputStream implementations
- EventListener implementations
- Lock implementations
- ReadWriteLock implementations
- Condition implementations
- Map implementations
- Collection implementations

Field Summary

Fields
Modifier and Type Field and Description

static int DFLT_TO_STRING_COLLECTION_LIMIT

static boolean DFLT_TO_STRING_INCLUDE_SENSITIVE

static int DFLT_TO_STRING_MAX_LENGTH

Fields
Modifier and Type	Field and Description
`static int`	`DFLT_TO_STRING_COLLECTION_LIMIT`
`static boolean`	`DFLT_TO_STRING_INCLUDE_SENSITIVE`
`static int`	`DFLT_TO_STRING_MAX_LENGTH`

Constructor Summary

Constructors
Constructor and Description

GridToStringBuilder()

Constructors
Constructor and Description
`GridToStringBuilder()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`arrayToString(Object arr)` Returns limited string representation of array.
`static <T extends Number & Comparable<? super T>> String`	`compact(Collection<T> col, Function<T,T> nextValFun)` Returns sorted and compacted string representation of given `col`.
`static String`	`identity(Object obj)`
`static boolean`	`includeSensitive()` Return `true` if need to include sensitive data otherwise `false`.
`static <T> String`	`joinToString(@Nullable Iterable<T> list, @Nullable String separator, @Nullable String truncSuffix, int maxLen, int maxCnt)` Creates a string from the elements separated using `separator`.
`static void`	`setIncludeSensitiveSupplier(Supplier<Boolean> sup)` Setting the logic of the `includeSensitive()` method.
`static <T> String`	`toString(Class<T> cls, T obj)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String parent)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name, @Nullable Object val)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name, @Nullable Object val, boolean sens)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, boolean sens0, String name1, Object val1, boolean sens1)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, boolean sens0, String name1, Object val1, boolean sens1, String name2, Object val2, boolean sens2)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, boolean sens0, String name1, Object val1, boolean sens1, String name2, Object val2, boolean sens2, String name3, Object val3, boolean sens3)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, boolean sens0, String name1, Object val1, boolean sens1, String name2, Object val2, boolean sens2, String name3, Object val3, boolean sens3, String name4, Object val4, boolean sens4)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, boolean sens0, String name1, Object val1, boolean sens1, String name2, Object val2, boolean sens2, String name3, Object val3, boolean sens3, String name4, Object val4, boolean sens4, String name5, Object val5, boolean sens5)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, boolean sens0, String name1, Object val1, boolean sens1, String name2, Object val2, boolean sens2, String name3, Object val3, boolean sens3, String name4, Object val4, boolean sens4, String name5, Object val5, boolean sens5, String name6, Object val6, boolean sens6)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, String name1, Object val1)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, String name1, Object val1, String name2, Object val2)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, String name1, Object val1, String name2, Object val2, String name3, Object val3)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, String name1, Object val1, String name2, Object val2, String name3, Object val3, String name4, Object val4)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, String name1, Object val1, String name2, Object val2, String name3, Object val3, String name4, Object val4, String name5, Object val5)` Produces auto-generated output of string presentation for given object and its declaration class.
`static <T> String`	`toString(Class<T> cls, T obj, String name0, Object val0, String name1, Object val1, String name2, Object val2, String name3, Object val3, String name4, Object val4, String name5, Object val5, String name6, Object val6)` Produces auto-generated output of string presentation for given object and its declaration class.
`static String`	`toString(String str, Object... triplets)` Produces uniformed output of string with context properties
`static String`	`toString(String str, String name, @Nullable Object val)` Produces uniformed output of string with context properties
`static String`	`toString(String str, String name, @Nullable Object val, boolean sens)` Produces uniformed output of string with context properties
`static String`	`toString(String str, String name0, @Nullable Object val0, boolean sens0, String name1, @Nullable Object val1, boolean sens1)` Produces uniformed output of string with context properties
`static String`	`toString(String str, String name0, @Nullable Object val0, boolean sens0, String name1, @Nullable Object val1, boolean sens1, String name2, @Nullable Object val2, boolean sens2)` Produces uniformed output of string with context properties
`static String`	`toString(String str, String name0, @Nullable Object val0, boolean sens0, String name1, @Nullable Object val1, boolean sens1, String name2, @Nullable Object val2, boolean sens2, String name3, @Nullable Object val3, boolean sens3)` Produces uniformed output of string with context properties
`static String`	`toString(String str, String name0, @Nullable Object val0, boolean sens0, String name1, @Nullable Object val1, boolean sens1, String name2, @Nullable Object val2, boolean sens2, String name3, @Nullable Object val3, boolean sens3, String name4, @Nullable Object val4, boolean sens4)` Produces uniformed output of string with context properties
`static String`	`toString(String str, String name0, @Nullable Object val0, boolean sens0, String name1, @Nullable Object val1, boolean sens1, String name2, @Nullable Object val2, boolean sens2, String name3, @Nullable Object val3, boolean sens3, String name4, @Nullable Object val4, boolean sens4, String name5, @Nullable Object val5, boolean sens5)` Produces uniformed output of string with context properties
`static String`	`toString(String str, String name0, @Nullable Object val0, boolean sens0, String name1, @Nullable Object val1, boolean sens1, String name2, @Nullable Object val2, boolean sens2, String name3, @Nullable Object val3, boolean sens3, String name4, @Nullable Object val4, boolean sens4, String name5, @Nullable Object val5, boolean sens5, String name6, @Nullable Object val6, boolean sens6)` Produces uniformed output of string with context properties
`static String`	`toString(String str, String name0, @Nullable Object val0, String name1, @Nullable Object val1)` Produces uniformed output of string with context properties
`static String`	`toStringSortedDistinct(Collection<? extends Comparable<?>> c)` Creates string representation of a specified collection with preliminary sorting and duplicates removing.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- DFLT_TO_STRING_MAX_LENGTH
```
public static final int DFLT_TO_STRING_MAX_LENGTH
```
  See Also:
  
  IgniteSystemProperties.IGNITE_TO_STRING_MAX_LENGTH, Constant Field Values
- DFLT_TO_STRING_INCLUDE_SENSITIVE
```
public static final boolean DFLT_TO_STRING_INCLUDE_SENSITIVE
```
  See Also:
  
  IgniteSystemProperties.IGNITE_TO_STRING_INCLUDE_SENSITIVE, Constant Field Values
- DFLT_TO_STRING_COLLECTION_LIMIT
```
public static final int DFLT_TO_STRING_COLLECTION_LIMIT
```
  See Also:
  
  IgniteSystemProperties.IGNITE_TO_STRING_COLLECTION_LIMIT, Constant Field Values

Constructor Detail
- GridToStringBuilder
```
public GridToStringBuilder()
```

Method Detail

setIncludeSensitiveSupplier
```
public static void setIncludeSensitiveSupplier(Supplier<Boolean> sup)
```
Setting the logic of the includeSensitive() method.
By default, it take the value of IGNITE_TO_STRING_INCLUDE_SENSITIVE system property.
Important! Changing the logic is possible only until the first call of includeSensitive() method.

Parameters:

sup -

includeSensitive
```
public static boolean includeSensitive()
```
Return true if need to include sensitive data otherwise false.

Returns:

true if need to include sensitive data otherwise false.

See Also:

setIncludeSensitiveSupplier(Supplier)

identity
```
public static String identity(Object obj)
```
Parameters:

obj - Object.

Returns:

Hexed identity hashcode.