public interface IResult
IRule
implementations. The default use
is to use ResultBuilder
, but this interface exists to allow further customization by
downstream users.Modifier and Type | Method and Description |
---|---|
java.lang.String |
getExplanation()
A more detailed explanation of what kind of problem was identified and why the identified
issue is a problem.
|
<T> T |
getPreference(TypedPreference<T> preference)
Returns a preference value that was used when evaluating the rule for this particular result.
|
<T> java.util.Collection<T> |
getResult(TypedCollectionResult<T> result)
Returns a collection of typed instances of a result contained in this result instance, i.e.
|
<T> T |
getResult(TypedResult<T> result)
Returns a typed instance of a result contained in this result instance, i.e.
|
IRule |
getRule()
Returns the
IRule that generated this result object. |
Severity |
getSeverity()
Returns an enum of type
Severity describing the importance of this result. |
java.lang.String |
getSolution()
An attempted solution for the identified problem.
|
java.lang.String |
getSummary()
A short, one sentence, summary of the results of the rule evaluation.
|
java.util.Collection<IRecordingSetting> |
suggestRecordingSettings()
An optional field potentially used for rules that have a set of recording settings that may
help the rule return more detailed information.
|
Severity getSeverity()
Severity
describing the importance of this result.IRule getRule()
IRule
that generated this result object.java.lang.String getSummary()
OK
or
NA
this should not be expected to contain any information, but it may. If the
severity is INFO
or WARNING
this is expected to provide a very short summary
of the found problem.java.lang.String getExplanation()
java.lang.String getSolution()
java.util.Collection<IRecordingSetting> suggestRecordingSettings()
<T> java.util.Collection<T> getResult(TypedCollectionResult<T> result)
IRule.getResults()
.T
- a type parameterresult
- the typed result that is to be retrieved<T> T getPreference(TypedPreference<T> preference)
T
- a type parameterpreference
- a preference used by this rule, i.e. contained in
IRule.getConfigurationAttributes()
<T> T getResult(TypedResult<T> result)
IRule.getResults()
.T
- a type parameterresult
- the typed result that is to be retrieved