Checkstyle Results

The following document contains the results of Checkstyle 10.17.0 with checkstyle.xml ruleset.

Summary

Files	Info	Warnings	Errors
57	0	171	0

Files

File	I	W	E
org/mybatis/logging/Logger.java	0	3	0
org/mybatis/logging/LoggerFactory.java	0	1	0
org/mybatis/spring/MyBatisExceptionTranslator.java	0	4	0
org/mybatis/spring/MyBatisSystemException.java	0	2	0
org/mybatis/spring/SqlSessionFactoryBean.java	0	26	0
org/mybatis/spring/SqlSessionTemplate.java	0	10	0
org/mybatis/spring/SqlSessionUtils.java	0	6	0
org/mybatis/spring/annotation/MapperScan.java	0	15	0
org/mybatis/spring/annotation/MapperScannerRegistrar.java	0	3	0
org/mybatis/spring/annotation/MapperScans.java	0	4	0
org/mybatis/spring/annotation/package-info.java	0	1	0
org/mybatis/spring/batch/MyBatisBatchItemWriter.java	0	10	0
org/mybatis/spring/batch/MyBatisCursorItemReader.java	0	2	0
org/mybatis/spring/batch/MyBatisPagingItemReader.java	0	3	0
org/mybatis/spring/batch/builder/MyBatisBatchItemWriterBuilder.java	0	1	0
org/mybatis/spring/batch/builder/MyBatisCursorItemReaderBuilder.java	0	1	0
org/mybatis/spring/batch/builder/MyBatisPagingItemReaderBuilder.java	0	1	0
org/mybatis/spring/config/MapperScannerBeanDefinitionParser.java	0	1	0
org/mybatis/spring/mapper/ClassPathMapperScanner.java	0	8	0
org/mybatis/spring/mapper/MapperFactoryBean.java	0	10	0
org/mybatis/spring/mapper/MapperScannerConfigurer.java	0	41	0
org/mybatis/spring/support/SqlSessionDaoSupport.java	0	8	0
org/mybatis/spring/transaction/SpringManagedTransaction.java	0	8	0
org/mybatis/spring/transaction/SpringManagedTransactionFactory.java	0	2	0

Rules

Category	Rule	Violations	Severity
imports	CustomImportOrder separateLineBetweenGroups: "true" sortImportsInGroupAlphabetically: "true" customImportOrderRules: "STATIC###THIRD_PARTY_PACKAGE" tokens: "IMPORT, STATIC_IMPORT, PACKAGE_DEF"	22	Warning
javadoc	AtclauseOrder tagOrder: "@param, @return, @throws, @deprecated" target: "CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"	2	Warning
	JavadocParagraph	125	Warning
	MissingJavadocMethod scope: "public" tokens: "METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF" minLineCount: "2" allowedAnnotations: "Override, Test"	4	Warning
	SummaryJavadoc forbiddenSummaryFragments: "^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"	12	Warning
naming	ParameterName format: "^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"	1	Warning
sizes	LineLength fileExtensions: "java" max: "120" ignorePattern: "^package.*|^import.*|a href|href|http://|https://|ftp://"	4	Error
whitespace	WhitespaceAround allowEmptyConstructors: "true" ignoreEnhancedForColon: "false" allowEmptyLambdas: "true" allowEmptyMethods: "true" allowEmptyLoops: "true" tokens: "ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND, LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND" allowEmptyTypes: "true"	1	Warning

Details

org/mybatis/logging/Logger.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.logging.Log'	20
Warning	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	47
Warning	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	53

org/mybatis/logging/LoggerFactory.java

Severity	Category	Rule	Message	Line
Warning	naming	ParameterName	Parameter name 'aClass' must match pattern '^[a-z]([a-z0-9][a-zA-Z0-9]*)?$'.	31

org/mybatis/spring/MyBatisExceptionTranslator.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'javax.sql.DataSource'	21
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.exceptions.PersistenceException'	23
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	33
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	33

org/mybatis/spring/MyBatisSystemException.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	23
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	23

org/mybatis/spring/SqlSessionFactoryBean.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'javax.sql.DataSource'	37
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.builder.xml.XMLConfigBuilder'	39
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	76
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	76
Warning	javadoc	SummaryJavadoc	First sentence of Javadoc is missing an ending period.	174
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	249
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	249
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	276
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	276
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	364
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	364
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	392
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	392
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	395
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	395
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	419
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	419
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	432
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	432
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	436
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	436
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	487
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	487
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	577
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	577
Warning	whitespace	WhitespaceAround	WhitespaceAround: '{' is not followed by whitespace. Empty blocks may only be represented as {} when not part of a multi-block statement (4.1.3)	657

org/mybatis/spring/SqlSessionTemplate.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.reflection.ExceptionUtil.unwrapThrowable'	20
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.cursor.Cursor'	32
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	49
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	49
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	53
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	53
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	56
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	56
Warning	javadoc	JavadocParagraph	Empty line should be followed by <p> tag on the next line.	308
Warning	sizes	LineLength	Line is longer than 120 characters (found 133).	313

org/mybatis/spring/SqlSessionUtils.java

Severity	Category	Rule	Message	Line
Warning	javadoc	SummaryJavadoc	First sentence of Javadoc is missing an ending period.	55
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	117
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	117
Warning	sizes	LineLength	Line is longer than 120 characters (found 132).	151
Warning	javadoc	SummaryJavadoc	First sentence of Javadoc is missing an ending period.	176
Warning	javadoc	SummaryJavadoc	First sentence of Javadoc is missing an ending period.	200

org/mybatis/spring/annotation/MapperScan.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.mybatis.spring.mapper.MapperFactoryBean'	26
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	37
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	37
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	106
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	106
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	123
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	123
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	125
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	125
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	134
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	134
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	137
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	137
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	191
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	191

org/mybatis/spring/annotation/MapperScannerRegistrar.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.mybatis.spring.mapper.ClassPathMapperScanner'	26
Warning	javadoc	SummaryJavadoc	First sentence of Javadoc is missing an ending period.	163
Warning	javadoc	SummaryJavadoc	First sentence of Javadoc is missing an ending period.	193

org/mybatis/spring/annotation/MapperScans.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.springframework.context.annotation.Import'	24
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	28
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	28
Warning	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	44

org/mybatis/spring/annotation/package-info.java

Severity	Category	Rule	Message	Line
Warning	javadoc	SummaryJavadoc	First sentence of Javadoc is missing an ending period.	16

org/mybatis/spring/batch/MyBatisBatchItemWriter.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	37
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	37
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	39
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	39
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	41
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	41
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	44
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	44
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	109
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	109

org/mybatis/spring/batch/MyBatisCursorItemReader.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.cursor.Cursor'	27
Warning	javadoc	SummaryJavadoc	Summary javadoc is missing.	34

org/mybatis/spring/batch/MyBatisPagingItemReader.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.session.ExecutorType'	27
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	35
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	35

org/mybatis/spring/batch/builder/MyBatisBatchItemWriterBuilder.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.session.SqlSessionFactory'	20

org/mybatis/spring/batch/builder/MyBatisCursorItemReaderBuilder.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.session.SqlSessionFactory'	22

org/mybatis/spring/batch/builder/MyBatisPagingItemReaderBuilder.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.session.SqlSessionFactory'	22

org/mybatis/spring/config/MapperScannerBeanDefinitionParser.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.mybatis.spring.mapper.ClassPathMapperScanner'	24

org/mybatis/spring/mapper/ClassPathMapperScanner.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.io.Resources'	24
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	52
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	52
Warning	javadoc	MissingJavadocMethod	Missing a Javadoc comment.	93
Warning	javadoc	SummaryJavadoc	Summary javadoc is missing.	99
Warning	javadoc	SummaryJavadoc	Summary javadoc is missing.	171
Warning	sizes	LineLength	Line is longer than 120 characters (found 121).	317
Warning	sizes	LineLength	Line is longer than 120 characters (found 121).	325

org/mybatis/spring/mapper/MapperFactoryBean.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	28
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	28
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	46
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	46
Warning	javadoc	SummaryJavadoc	First sentence of Javadoc is missing an ending period.	103
Warning	javadoc	SummaryJavadoc	First sentence of Javadoc is missing an ending period.	113
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	125
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	125
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	127
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	127

org/mybatis/spring/mapper/MapperScannerConfigurer.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.session.SqlSessionFactory'	27
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	57
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	57
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	61
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	61
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	63
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	63
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	69
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	69
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	76
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	76
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	81
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	81
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	139
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	139
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	141
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	141
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	180
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	180
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	182
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	182
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	194
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	194
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	197
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	197
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	209
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	209
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	223
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	223
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	238
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	238
Warning	javadoc	AtclauseOrder	Block tags have to appear in the order '[@param, @return, @throws, @deprecated]'.	242
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	253
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	253
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	269
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	269
Warning	javadoc	AtclauseOrder	Block tags have to appear in the order '[@param, @return, @throws, @deprecated]'.	273
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	284
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	284
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	299
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	299

org/mybatis/spring/support/SqlSessionDaoSupport.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	28
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	28
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	30
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	30
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	59
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	59
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	108
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	108

org/mybatis/spring/transaction/SpringManagedTransaction.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'javax.sql.DataSource'	23
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.transaction.Transaction'	25
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	35
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	35
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	38
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	38
Warning	javadoc	JavadocParagraph	<p> tag should be placed immediately before the first word, with no space after.	72
Warning	javadoc	JavadocParagraph	<p> tag should be preceded with an empty line.	72

org/mybatis/spring/transaction/SpringManagedTransactionFactory.java

Severity	Category	Rule	Message	Line
Warning	imports	CustomImportOrder	Extra separation in import group before 'javax.sql.DataSource'	21
Warning	imports	CustomImportOrder	Extra separation in import group before 'org.apache.ibatis.session.TransactionIsolationLevel'	23