Fork me on GitHub
Built by Maven

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 41

Files

File  I  W  E
edu/pdx/cs/joy/airline/Airline.java 0 0 10
edu/pdx/cs/joy/airline/AirlineXmlHelper.java 0 0 3
edu/pdx/cs/joy/airline/Flight.java 0 0 10
edu/pdx/cs/joy/airline/Project1.java 0 0 7
edu/pdx/cs/joy/airline/TextDumper.java 0 0 6
edu/pdx/cs/joy/airline/TextParser.java 0 0 5

Rules

Category Rule Violations Severity
coding HiddenField 3  Error
MagicNumber 1  Error
design DesignForExtension 10  Error
HideUtilityClassConstructor 1  Error
javadoc JavadocPackage 1  Error
JavadocStyle 2  Error
JavadocVariable 3  Error
MissingJavadocMethod 5  Error
misc FinalParameters 7  Error
NewlineAtEndOfFile 1  Error
sizes LineLength
  • fileExtensions: "java"
 7  Error

Details

edu/pdx/cs/joy/airline/Airline.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 name should be final. 10
 Error coding HiddenField 'name' hides a field. 10
 Error design DesignForExtension Class 'Airline' looks like designed for extension (can be subclassed), but the method 'getName' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Airline' final or making the method 'getName' static/final/abstract/empty, or adding allowed annotation for the method. 14
 Error design DesignForExtension Class 'Airline' looks like designed for extension (can be subclassed), but the method 'addFlight' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Airline' final or making the method 'addFlight' static/final/abstract/empty, or adding allowed annotation for the method. 19
 Error misc FinalParameters Parameter flight should be final. 20
 Error sizes LineLength Line is longer than 80 characters (found 82). 21
 Error design DesignForExtension Class 'Airline' looks like designed for extension (can be subclassed), but the method 'getFlights' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Airline' final or making the method 'getFlights' static/final/abstract/empty, or adding allowed annotation for the method. 24
 Error sizes LineLength Line is longer than 80 characters (found 82). 26

edu/pdx/cs/joy/airline/AirlineXmlHelper.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file. 1
 Error javadoc JavadocStyle First sentence should end with a period. 11
 Error javadoc MissingJavadocMethod Missing a Javadoc comment. 16

edu/pdx/cs/joy/airline/Flight.java

Severity Category Rule Message Line
 Error design DesignForExtension Class 'Flight' looks like designed for extension (can be subclassed), but the method 'getNumber' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Flight' final or making the method 'getNumber' static/final/abstract/empty, or adding allowed annotation for the method. 6
 Error coding MagicNumber '42' is a magic number. 8
 Error design DesignForExtension Class 'Flight' looks like designed for extension (can be subclassed), but the method 'getSource' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Flight' final or making the method 'getSource' 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 'Flight' looks like designed for extension (can be subclassed), but the method 'getDepartureString' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Flight' final or making the method 'getDepartureString' static/final/abstract/empty, or adding allowed annotation for the method. 16
 Error sizes LineLength Line is longer than 80 characters (found 82). 18
 Error design DesignForExtension Class 'Flight' looks like designed for extension (can be subclassed), but the method 'getDestination' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Flight' final or making the method 'getDestination' static/final/abstract/empty, or adding allowed annotation for the method. 21
 Error sizes LineLength Line is longer than 80 characters (found 82). 23
 Error design DesignForExtension Class 'Flight' looks like designed for extension (can be subclassed), but the method 'getArrivalString' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Flight' final or making the method 'getArrivalString' static/final/abstract/empty, or adding allowed annotation for the method. 26
 Error sizes LineLength Line is longer than 80 characters (found 82). 28

edu/pdx/cs/joy/airline/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 114). 16

edu/pdx/cs/joy/airline/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 airline should be final. 19

edu/pdx/cs/joy/airline/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