com.screenscraper.util.objectlogger

Class LoggableValue

java.lang.Object

com.screenscraper.util.objectlogger.LoggableValue

All Implemented Interfaces:

java.lang.Comparable<LoggableValue>

public class LoggableValue
extends java.lang.Object
implements java.lang.Comparable<LoggableValue>

Represents a value that can be written to the log

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String	UNSET_DISPLAY_KEY_NAME

Constructor Summary

Constructors

Constructor and Description
LoggableValue(java.lang.String valueWebStyle, java.lang.String typeName, java.lang.String displayValue, java.util.Collection<?> children) Creates a new loggable value
LoggableValue(java.lang.String valueWebStyle, java.lang.String typeName, java.lang.String displayValue, java.util.Map<java.lang.String,?> children) Creates a new loggable value

Method Summary

Modifier and Type	Method and Description
void	accept(LoggableVisitor visitor)
int	compareTo(LoggableValue other)
boolean	equals(java.lang.Object o)
java.util.List<LoggableValue>	getChildren()
java.lang.String	getDisplayKeyName()
java.lang.String	getDisplayValue()
java.lang.String	getTypeName()
java.lang.String	getValueWebStyle()
int	hashCode()
void	setDisplayKeyName(java.lang.String displayKeyName)
void	setHideChildren(boolean hideChildren)
boolean	shouldHideChildren()

Methods inherited from class java.lang.Object

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

Field Detail

UNSET_DISPLAY_KEY_NAME

static final java.lang.String UNSET_DISPLAY_KEY_NAME

See Also:

Constant Field Values

Constructor Detail

LoggableValue

public LoggableValue(@NotNull
                     java.lang.String valueWebStyle,
                     @NotNull
                     java.lang.String typeName,
                     @NotNull
                     java.lang.String displayValue,
                     @Nullable
                     java.util.Map<java.lang.String,?> children)

Creates a new loggable value

Parameters:

valueWebStyle - The styling for the value display in the web interface

typeName - The name of the type of data (for example, could just be Map). This is general the class name

displayValue - The actual data to display. If something other than a primitive, null, or string is used here, then it will be converted if possible to a friendlier log format

children - A collection of children of this element (mapped by key -> value). These values will be converted automatically to a pretty format if possible

LoggableValue

public LoggableValue(@NotNull
                     java.lang.String valueWebStyle,
                     @NotNull
                     java.lang.String typeName,
                     @NotNull
                     java.lang.String displayValue,
                     @Nullable
                     java.util.Collection<?> children)

Creates a new loggable value

Parameters:

valueWebStyle - The styling for the value display in the web interface

typeName - The name of the type of data (for example, could just be Map). This is general the class name

displayValue - The actual data to display. If something other than a primitive, null, or string is used here, then it will be converted if possible to a friendlier log format

children - A collection of children of this element, in the order to display them. These values will be converted automatically to a pretty format if possible

Method Detail

shouldHideChildren

public boolean shouldHideChildren()

setHideChildren

public void setHideChildren(boolean hideChildren)

setDisplayKeyName

public void setDisplayKeyName(@NotNull
                              java.lang.String displayKeyName)

getDisplayKeyName

@NotNull
public java.lang.String getDisplayKeyName()

getTypeName

@NotNull
public java.lang.String getTypeName()

getDisplayValue

@NotNull
public java.lang.String getDisplayValue()

getChildren

@NotNull
public java.util.List<LoggableValue> getChildren()

getValueWebStyle

@NotNull
public java.lang.String getValueWebStyle()

accept

public void accept(@NotNull
                   LoggableVisitor visitor)

compareTo

public int compareTo(@NotNull
                     LoggableValue other)

Specified by:

compareTo in interface java.lang.Comparable<LoggableValue>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object