org.yarnandtail.andhow.internal

Class ConstructionProblem

java.lang.Object

org.yarnandtail.andhow.internal.ConstructionProblem

All Implemented Interfaces:

Problem

Direct Known Subclasses:

ConstructionProblem.DuplicateLoader, ConstructionProblem.DuplicateProperty, ConstructionProblem.ExportException, ConstructionProblem.InvalidDefaultValue, ConstructionProblem.InvalidValidationConfiguration, ConstructionProblem.LoaderPropertyIsNull, ConstructionProblem.LoaderPropertyNotRegistered, ConstructionProblem.NonUniqueNames, ConstructionProblem.PropertyNotPartOfGroup, ConstructionProblem.SecurityException

public abstract class ConstructionProblem
extends Object
implements Problem

A problem bootstrapping the AndHow, prior to attempting to load any values.

Author:

ericeverman

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConstructionProblem.DuplicateLoader
static class	ConstructionProblem.DuplicateProperty
static class	ConstructionProblem.ExportException
static class	ConstructionProblem.InvalidDefaultValue
static class	ConstructionProblem.InvalidValidationConfiguration
static class	ConstructionProblem.LoaderPropertyIsNull
static class	ConstructionProblem.LoaderPropertyNotRegistered
static class	ConstructionProblem.NonUniqueNames
static class	ConstructionProblem.PropertyNotPartOfGroup
static class	ConstructionProblem.SecurityException

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyCoord	badPropertyCoord The Property that actually has the problem
protected PropertyCoord	refPropertyCoord For construction problems that duplicate or reference another Property...

Fields inherited from interface org.yarnandtail.andhow.api.Problem

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
ConstructionProblem()

Method Summary

Modifier and Type	Method and Description
PropertyCoord	getBadPropertyCoord() The Property that has the problem.
String	getFullMessage() A complete description of the problem w/ context and problem description.
String	getProblemContext() The context for the problem, for the user.
PropertyCoord	getRefPropertyCoord() For Properties that have some type of duplication w/ other properties, this is the Property that is duplicated (the earlier of the two duplicates).

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yarnandtail.andhow.api.Problem

getProblemDescription

Field Detail

badPropertyCoord

protected PropertyCoord badPropertyCoord

The Property that actually has the problem

refPropertyCoord

protected PropertyCoord refPropertyCoord

For construction problems that duplicate or reference another Property...

Constructor Detail

ConstructionProblem

public ConstructionProblem()

Method Detail

getRefPropertyCoord

public PropertyCoord getRefPropertyCoord()

For Properties that have some type of duplication w/ other properties, this is the Property that is duplicated (the earlier of the two duplicates).

Returns:

May return null if not applicable.

getBadPropertyCoord

public PropertyCoord getBadPropertyCoord()

The Property that has the problem.

Returns:

May return null if not applicable.

getProblemContext

public String getProblemContext()

Description copied from interface: Problem

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.

Specified by:

getProblemContext in interface Problem

Returns:

getFullMessage

public String getFullMessage()

Description copied from interface: Problem

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

Specified by:

getFullMessage in interface Problem

Returns: