|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectanl.aida.formula.ValidationResult
public class ValidationResult
Encapsulates the result of validating a Formula.
Nested Class Summary | |
---|---|
static class |
ValidationResult.Status
|
Field Summary | |
---|---|
private IllegalFormulaException |
ex
|
private java.lang.String |
message
|
private java.util.Map<java.lang.String,java.lang.Object> |
props
|
private ValidationResult.Status |
status
|
private java.util.List<FormulaVariable> |
variables
|
Constructor Summary | |
---|---|
private |
ValidationResult(IllegalFormulaException ex,
ValidationResult.Status status)
|
private |
ValidationResult(java.lang.String message,
ValidationResult.Status status)
|
Method Summary | |
---|---|
static ValidationResult |
fail(IllegalFormulaException ex)
Creates a failed result using the specified exception. |
static ValidationResult |
fail(java.lang.String message)
Creates a failed result. |
IllegalFormulaException |
getException()
Gets the exception if any associated with the status. |
java.lang.String |
getMessage()
Gets the message explaining the status. |
java.lang.Object |
getProperty(java.lang.String name)
Gets an arbitrary property from the result. |
ValidationResult.Status |
getStatus()
Gets the status of the result. |
java.util.List<FormulaVariable> |
getVariables()
Gets the variables in the formula. |
static ValidationResult |
pass()
Creates a passing result. |
void |
putProperty(java.lang.String name,
java.lang.Object prop)
Puts a property into this result. |
(package private) void |
setVariables(java.util.List<FormulaVariable> variables)
|
static ValidationResult |
warn(IllegalFormulaException ex)
Creates a warning result using the specified exception. |
static ValidationResult |
warn(java.lang.String message)
Creates a warning result. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private ValidationResult.Status status
private java.lang.String message
private IllegalFormulaException ex
private java.util.List<FormulaVariable> variables
private java.util.Map<java.lang.String,java.lang.Object> props
Constructor Detail |
---|
private ValidationResult(IllegalFormulaException ex, ValidationResult.Status status)
private ValidationResult(java.lang.String message, ValidationResult.Status status)
Method Detail |
---|
public static ValidationResult fail(IllegalFormulaException ex)
ex
- the exception containing the details of the failure.
public static ValidationResult warn(IllegalFormulaException ex)
ex
- the exception containing the details of the warning.
public static ValidationResult fail(java.lang.String message)
message
- contains the details of the warning.
public static ValidationResult pass()
public static ValidationResult warn(java.lang.String message)
message
- contains the details of the warning.
public java.util.List<FormulaVariable> getVariables()
void setVariables(java.util.List<FormulaVariable> variables)
public ValidationResult.Status getStatus()
public java.lang.String getMessage()
public IllegalFormulaException getException()
public java.lang.Object getProperty(java.lang.String name)
public void putProperty(java.lang.String name, java.lang.Object prop)
name
- the name of the propertyprop
- the value of the property
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |