org.yarnandtail.andhow.api

Interface Problem

All Known Implementing Classes:

ConstructionProblem, ConstructionProblem.DuplicateLoader, ConstructionProblem.DuplicateProperty, ConstructionProblem.ExportException, ConstructionProblem.InvalidDefaultValue, ConstructionProblem.InvalidValidationConfiguration, ConstructionProblem.LoaderPropertyIsNull, ConstructionProblem.LoaderPropertyNotRegistered, ConstructionProblem.NonUniqueNames, ConstructionProblem.PropertyNotPartOfGroup, ConstructionProblem.SecurityException, LoaderProblem, LoaderProblem.DuplicatePropertyLoaderProblem, LoaderProblem.IOLoaderProblem, LoaderProblem.JndiContextLoaderProblem, LoaderProblem.ObjectConversionValueProblem, LoaderProblem.ParsingLoaderProblem, LoaderProblem.SourceNotFoundLoaderProblem, LoaderProblem.StringConversionLoaderProblem, LoaderProblem.UnknownPropertyLoaderProblem, RequirementProblem, RequirementProblem.RequiredPropertyGroupProblem, RequirementProblem.RequiredPropertyProblem, ValueProblem, ValueProblem.InvalidValueProblem

public interface Problem

Author:

ericeverman

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNKNOWN

Method Summary

Modifier and Type	Method and Description
String	getFullMessage() A complete description of the problem w/ context and problem description.
String	getProblemContext() The context for the problem, for the user.
String	getProblemDescription() The problem description, for the user.

Field Detail

UNKNOWN

static final String UNKNOWN

See Also:

Constant Field Values

Method Detail

getFullMessage

String getFullMessage()

A complete description of the problem w/ context and problem description. Constructed by stringing the problem context and the problem description together: [Context]: [Description]

Returns:

getProblemContext

String getProblemContext()

The context for the problem, for the user. For a construction problem for a property, this would be the Property canonical name. For a invalid value, it might be the Property name and where it was loaded from.

Returns:

getProblemDescription

String getProblemDescription()

The problem description, for the user. It should be able to be tacked on to the problem context.

Returns: