Package nz.org.riskscape.engine.i18n

Class RenderedProblem

java.lang.Object

nz.org.riskscape.engine.i18n.RenderedProblem

public class RenderedProblem
extends Object

Returned from Messages.renderProblem(Problem, java.util.Locale) to translate a problem while maintaining its tree structure. This should allow UIs to present it appropriately without having to translate it all individually.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RenderedProblem.ToStringOptions	Used for customizing the output of toString

Field Summary

Fields

Modifier and Type	Field	Description
final List<RenderedProblem>	children	A list of RenderedProblems for each child in source
final int	indentLevel	The number of ancestors this problem has
final String	message	The translated message for the source problem
final Problem	source	The thing that caused all the problems

Constructor Summary

Constructors

Constructor	Description
RenderedProblem(String message, Problem source)
RenderedProblem(String message, Problem source, int indentLevel, List<RenderedProblem> children)	Creates a new RenderedProblem instance.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<RenderedProblem>	getChildren()	A list of RenderedProblems for each child in source
int	getIndentLevel()	The number of ancestors this problem has
String	getMessage()	The translated message for the source problem
Problem	getSource()	The thing that caused all the problems
int	hashCode()
List<RenderedProblem>	toList()	Convert this RenderedProblem in to a list, as per a depth-first search of this RenderedProblem
String	toString()	Returns a line separated, indented version of this problem and its children
String	toString(Consumer<RenderedProblem.ToStringOptions> customize)	Returns a line separated, indented version of this problem and its children
String	toString(RenderedProblem.ToStringOptions options)

Methods inherited from class java.lang.Object

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

Field Details

message

public final String message

The translated message for the source problem

source

public final Problem source

The thing that caused all the problems

indentLevel

public final int indentLevel

The number of ancestors this problem has

children

public final List<RenderedProblem> children

A list of RenderedProblems for each child in source

Constructor Details

RenderedProblem

public RenderedProblem(String message,
 Problem source)

RenderedProblem

public RenderedProblem(String message,
 Problem source,
 int indentLevel,
 List<RenderedProblem> children)

Creates a new RenderedProblem instance.

Parameters:

message - The translated message for the source problem

source - The thing that caused all the problems

indentLevel - The number of ancestors this problem has

children - A list of RenderedProblems for each child in source

Method Details

toList

public List<RenderedProblem> toList()

Convert this RenderedProblem in to a list, as per a depth-first search of this RenderedProblem

Returns:

toString

public String toString(Consumer<RenderedProblem.ToStringOptions> customize)

Returns a line separated, indented version of this problem and its children

toString

public String toString(RenderedProblem.ToStringOptions options)

toString

public String toString()

Returns a line separated, indented version of this problem and its children

Overrides:

toString in class Object

getMessage

public String getMessage()

The translated message for the source problem

getSource

public Problem getSource()

The thing that caused all the problems

getIndentLevel

public int getIndentLevel()

The number of ancestors this problem has

getChildren

public List<RenderedProblem> getChildren()

A list of RenderedProblems for each child in source

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object