|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD | DETAIL: FIELD | PROPERTY | CONSTR | METHOD |
java.lang.Objectlsst.gruth.grutils.AnnotatedReport
class AnnotatedReport
used to store TztReport with notes about modification and handling of the corresponding report
Nested Class Summary | |
---|---|
enum |
AnnotatedReport.Origin
|
Property Summary | |
---|---|
Advice |
advice
advice addded by user (or by automatic comprison tool) |
boolean |
beenThroughAutomaticComparison
this report has been through automatic comparison |
Modification |
modification
nature of modification of the annotation |
Origin |
modificationOrigin
who modified |
AnnotatedReport |
neededPreviousReport
in case of regression last correct annotated report. |
int |
neededPreviousVersion
in case of regression last correct version (-1 means no prvious correct version kept) |
TztReport |
report
the original report as created by the test run |
java.lang.String |
userComment
user added a comment on this test |
Constructor Summary | |
AnnotatedReport(TztReport report)
"normal" constructor. |
|
AnnotatedReport(Modification modification, Advice advice, TztReport report)
use this constructor for test purposes only |
|
AnnotatedReport(Modification modification, Advice advice, java.lang.String userComment, int neededPreviousVersion, AnnotatedReport neededPreviousReport, TztReport report)
use this constructor for test purposes only |
Method Summary | |
---|---|
void
|
automaticModification(AnnotatedReport previous, int currentVersion, int previousVersion)
/ if (beenThroughAutomaticComparison) { beenThroughAutomaticComparison = false; //TODO: think! |
AnnotatedReport
|
clone()
|
int
|
compareTo(AnnotatedReport other)
|
private void
|
confused(AnnotatedReport previous, int currentVersion, int previousVersion)
the comparison looks incoherent: user advice is requested |
private void
|
copy(AnnotatedReport previous, int currentVersion, int previousVersion)
automatic comparison copies a previous user's advice. |
private void
|
diagEqualsResultsDiffer(AnnotatedReport previous, int currentVersion, int previousVersion)
two versions of the test get same diagnostic with differing results |
boolean
|
equals(java.lang.Object o)
|
Advice
|
getAdvice()
|
Modification
|
getModification()
|
AnnotatedReport.Origin
|
getModificationOrigin()
|
TztReport
|
getReport()
|
java.lang.String
|
getUserComment()
|
private void
|
lostResults(AnnotatedReport previous, int currentVersion, int previousVersion)
happens when suddenly a test becomes NOT-YET-IMPLEMENTED or NOT-EVALUATED (but was not before!) |
private void
|
progress(AnnotatedReport previous, int currentVersion, int previousVersion)
marks a progress ... in fact does nothing for the moment |
private void
|
regression(AnnotatedReport previous, int currentVersion, int previousVersion)
automatic comparison detected a Major regression |
void
|
setAdvice(Advice advice)
|
void
|
setModification(Modification modification)
|
void
|
setModificationOrigin(AnnotatedReport.Origin modificationOrigin)
|
void
|
setUserComment(java.lang.String userComment)
|
private void
|
smallRegression(AnnotatedReport previous, int currentVersion, int previousVersion)
automatic comparison detected a minor regression a "minor regression" happens when diagnostic skips from SUCCESS to NEUTRAL or WARNINGS or from NEUTRAL to WARNINGS |
void
|
userModification(Advice advice)
a user may modify an uncommented Report or a previously commented report (modified automatically) By adding/modifying and advice he/she changes the modification status that is considered no longer automatic |
AnnotatedReport
|
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
AnnotatedReport[]
|
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Object | |
---|---|
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Property Detail |
---|
Advice advice
boolean beenThroughAutomaticComparison
Modification modification
Origin modificationOrigin
AnnotatedReport neededPreviousReport
int neededPreviousVersion
TztReport report
java.lang.String userComment
Constructor Detail |
---|
AnnotatedReport(TztReport report)
AnnotatedReport(Modification modification, Advice advice, TztReport report)
AnnotatedReport(Modification modification, Advice advice, java.lang.String userComment, int neededPreviousVersion, AnnotatedReport neededPreviousReport, TztReport report)
Method Detail |
---|
void automaticModification(AnnotatedReport previous, int currentVersion, int previousVersion)
AnnotatedReport clone()
@Override int compareTo(AnnotatedReport other)
private void confused(AnnotatedReport previous, int currentVersion, int previousVersion)
private void copy(AnnotatedReport previous, int currentVersion, int previousVersion)
private void diagEqualsResultsDiffer(AnnotatedReport previous, int currentVersion, int previousVersion)
@Override boolean equals(java.lang.Object o)
Advice getAdvice()
Modification getModification()
AnnotatedReport.Origin getModificationOrigin()
TztReport getReport()
java.lang.String getUserComment()
private void lostResults(AnnotatedReport previous, int currentVersion, int previousVersion)
private void progress(AnnotatedReport previous, int currentVersion, int previousVersion)
private void regression(AnnotatedReport previous, int currentVersion, int previousVersion)
void setAdvice(Advice advice)
void setModification(Modification modification)
void setModificationOrigin(AnnotatedReport.Origin modificationOrigin)
void setUserComment(java.lang.String userComment)
private void smallRegression(AnnotatedReport previous, int currentVersion, int previousVersion)
void userModification(Advice advice)
AnnotatedReport valueOf(java.lang.String name)
AnnotatedReport[] values()
Groovy Documentation