Package io.deephaven.qst.table

Class FriendlyString

java.lang.Object

io.deephaven.qst.table.FriendlyString

public final class FriendlyString
extends Object

Constructor Summary

Constructors

Constructor	Description
FriendlyString()

Method Summary

Modifier and Type	Method	Description
static String	of(TableSpec tableSpec)	Constructs a "friendly", depth-limited, recursive string of the given tableSpec.
static String	of(TableSpec tableSpec, int maxAncestorDepth)	Constructs a "friendly" string of the given tableSpec.

Methods inherited from class java.lang.Object

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

Constructor Details

FriendlyString

public FriendlyString()

Method Details

of

public static String of(TableSpec tableSpec)

Constructs a "friendly", depth-limited, recursive string of the given tableSpec. The depth visited is limited by 10. This is a non de-duplicating construction, and is most useful for smaller sized table specs. Callers that prefer a de-duplicated construction that works efficiently with larger tables may prefer Graphviz.toDot(TableSpec).

Callers can use this for visualization and debugging purposes, but should not depend on the strings being equal from release to release.

Parameters:

tableSpec - the table spec

Returns:

the "friendly" string

of

public static String of(TableSpec tableSpec,
 int maxAncestorDepth)

Constructs a "friendly" string of the given tableSpec. The depth visited is limited by maxAncestorDepth. This is a non de-duplicating construction, and is most useful for smaller sized table specs. Callers that prefer a de-duplicated construction that works efficiently with larger tables may prefer Graphviz.toDot(TableSpec).

Callers can use this for visualization and debugging purposes, but should not depend on the strings being equal from release to release.

Parameters:

tableSpec - the table spec

maxAncestorDepth - the maximum number of ancestors to visit

Returns:

the "friendly" string