Checkstyle Results
The following document contains the results of Checkstyle 12.3.1 with sun_checks.xml ruleset.
Summary
| Files |
 Info |
 Warnings |
 Errors |
| 6 |
0 |
0 |
35 |
Details
edu/pdx/cs/joy/apptbook/Appointment.java
| Severity |
Category |
Rule |
Message |
Line |
| Error |
javadoc |
JavadocPackage |
Missing package-info.java file. |
1 |
| Error |
design |
DesignForExtension |
Class 'Appointment' looks like designed for extension (can be subclassed), but the method 'getBeginTimeString' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Appointment' final or making the method 'getBeginTimeString' static/final/abstract/empty, or adding allowed annotation for the method. |
6 |
| Error |
sizes |
LineLength |
Line is longer than 80 characters (found 82). |
8 |
| Error |
design |
DesignForExtension |
Class 'Appointment' looks like designed for extension (can be subclassed), but the method 'getEndTimeString' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Appointment' final or making the method 'getEndTimeString' static/final/abstract/empty, or adding allowed annotation for the method. |
11 |
| Error |
sizes |
LineLength |
Line is longer than 80 characters (found 82). |
13 |
| Error |
design |
DesignForExtension |
Class 'Appointment' looks like designed for extension (can be subclassed), but the method 'getDescription' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Appointment' final or making the method 'getDescription' static/final/abstract/empty, or adding allowed annotation for the method. |
16 |
edu/pdx/cs/joy/apptbook/AppointmentBook.java
| Severity |
Category |
Rule |
Message |
Line |
| Error |
javadoc |
JavadocVariable |
Missing a Javadoc comment. |
8 |
| Error |
javadoc |
MissingJavadocMethod |
Missing a Javadoc comment. |
10 |
| Error |
misc |
FinalParameters |
Parameter owner should be final. |
10 |
| Error |
coding |
HiddenField |
'owner' hides a field. |
10 |
| Error |
design |
DesignForExtension |
Class 'AppointmentBook' looks like designed for extension (can be subclassed), but the method 'getOwnerName' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AppointmentBook' final or making the method 'getOwnerName' static/final/abstract/empty, or adding allowed annotation for the method. |
14 |
| Error |
design |
DesignForExtension |
Class 'AppointmentBook' looks like designed for extension (can be subclassed), but the method 'getAppointments' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AppointmentBook' final or making the method 'getAppointments' static/final/abstract/empty, or adding allowed annotation for the method. |
19 |
| Error |
sizes |
LineLength |
Line is longer than 80 characters (found 82). |
21 |
| Error |
design |
DesignForExtension |
Class 'AppointmentBook' looks like designed for extension (can be subclassed), but the method 'addAppointment' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AppointmentBook' final or making the method 'addAppointment' static/final/abstract/empty, or adding allowed annotation for the method. |
24 |
| Error |
misc |
FinalParameters |
Parameter appt should be final. |
25 |
| Error |
sizes |
LineLength |
Line is longer than 80 characters (found 82). |
26 |
edu/pdx/cs/joy/apptbook/AppointmentBookXmlHelper.java
| Severity |
Category |
Rule |
Message |
Line |
| Error |
javadoc |
JavadocStyle |
First sentence should end with a period. |
7 |
edu/pdx/cs/joy/apptbook/Project1.java
| Severity |
Category |
Rule |
Message |
Line |
| Error |
misc |
NewlineAtEndOfFile |
File does not end with a newline. |
1 |
| Error |
javadoc |
JavadocStyle |
First sentence should end with a period. |
5 |
| Error |
design |
HideUtilityClassConstructor |
Utility classes should not have a public or default constructor. |
8 |
| Error |
misc |
FinalParameters |
Parameter dateAndTime should be final. |
11 |
| Error |
javadoc |
MissingJavadocMethod |
Missing a Javadoc comment. |
15 |
| Error |
misc |
FinalParameters |
Parameter args should be final. |
15 |
| Error |
sizes |
LineLength |
Line is longer than 80 characters (found 129). |
16 |
edu/pdx/cs/joy/apptbook/TextDumper.java
| Severity |
Category |
Rule |
Message |
Line |
| Error |
javadoc |
JavadocVariable |
Missing a Javadoc comment. |
12 |
| Error |
javadoc |
MissingJavadocMethod |
Missing a Javadoc comment. |
14 |
| Error |
misc |
FinalParameters |
Parameter writer should be final. |
14 |
| Error |
coding |
HiddenField |
'writer' hides a field. |
14 |
| Error |
design |
DesignForExtension |
Class 'TextDumper' looks like designed for extension (can be subclassed), but the method 'dump' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'TextDumper' final or making the method 'dump' static/final/abstract/empty, or adding allowed annotation for the method. |
18 |
| Error |
misc |
FinalParameters |
Parameter book should be final. |
19 |
edu/pdx/cs/joy/apptbook/TextParser.java
| Severity |
Category |
Rule |
Message |
Line |
| Error |
javadoc |
JavadocVariable |
Missing a Javadoc comment. |
14 |
| Error |
javadoc |
MissingJavadocMethod |
Missing a Javadoc comment. |
16 |
| Error |
misc |
FinalParameters |
Parameter reader should be final. |
16 |
| Error |
coding |
HiddenField |
'reader' hides a field. |
16 |
| Error |
design |
DesignForExtension |
Class 'TextParser' looks like designed for extension (can be subclassed), but the method 'parse' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'TextParser' final or making the method 'parse' static/final/abstract/empty, or adding allowed annotation for the method. |
20 |
