Apollo Core

##### Parent Project

- Apollo

##### Project Documentation

- Project Information
- Project Reports
  - Checkstyle
  - Cobertura Test Coverage

## Checkstyle Results

The following document contains the results of Checkstyle 6.18 with google_checks.xml ruleset.

## Summary

Files | Info | Warnings | Errors
--- | --- | --- | ---
35 | 0 | 103 | 0

## Files

File | I | W | E
--- | --- | --- | ---
com/ctrip/framework/apollo/Apollo.java | 0 | 1 | 0
com/ctrip/framework/apollo/core/MetaDomainConsts.java | 0 | 3 | 0
com/ctrip/framework/apollo/core/dto/ApolloConfig.java | 0 | 1 | 0
com/ctrip/framework/apollo/core/dto/ApolloConfigNotification.java | 0 | 3 | 0
com/ctrip/framework/apollo/core/dto/AppDTO.java | 0 | 2 | 0
com/ctrip/framework/apollo/core/dto/AppNamespaceDTO.java | 0 | 3 | 0
com/ctrip/framework/apollo/core/dto/BaseDTO.java | 0 | 1 | 0
com/ctrip/framework/apollo/core/dto/ClusterDTO.java | 0 | 2 | 0
com/ctrip/framework/apollo/core/dto/CommitDTO.java | 0 | 2 | 0
com/ctrip/framework/apollo/core/dto/ItemChangeSets.java | 0 | 3 | 0
com/ctrip/framework/apollo/core/dto/ItemDTO.java | 0 | 12 | 0
com/ctrip/framework/apollo/core/dto/NamespaceDTO.java | 0 | 2 | 0
com/ctrip/framework/apollo/core/dto/NamespaceLockDTO.java | 0 | 2 | 0
com/ctrip/framework/apollo/core/dto/ReleaseDTO.java | 0 | 2 | 0
com/ctrip/framework/apollo/core/dto/ServiceDTO.java | 0 | 1 | 0
com/ctrip/framework/apollo/core/enums/ConfigFileFormat.java | 0 | 5 | 0
com/ctrip/framework/apollo/core/enums/Env.java | 0 | 1 | 0
com/ctrip/framework/apollo/core/enums/EnvUtils.java | 0 | 1 | 0
com/ctrip/framework/apollo/core/exception/AbstractBaseException.java | 0 | 6 | 0
com/ctrip/framework/apollo/core/exception/BadRequestException.java | 0 | 1 | 0
com/ctrip/framework/apollo/core/exception/NotFoundException.java | 0 | 1 | 0
com/ctrip/framework/apollo/core/exception/ServiceException.java | 0 | 2 | 0
com/ctrip/framework/apollo/core/utils/ApolloThreadFactory.java | 0 | 2 | 0
com/ctrip/framework/apollo/core/utils/ByteUtil.java | 0 | 6 | 0
com/ctrip/framework/apollo/core/utils/ClassLoaderUtil.java | 0 | 1 | 0
com/ctrip/framework/apollo/core/utils/DNSUtil.java | 0 | 2 | 0
com/ctrip/framework/apollo/core/utils/MachineUtil.java | 0 | 1 | 0
com/ctrip/framework/apollo/core/utils/PropertiesUtil.java | 0 | 3 | 0
com/ctrip/framework/apollo/core/utils/ResourceUtils.java | 0 | 3 | 0
com/ctrip/framework/apollo/core/utils/StringUtils.java | 0 | 28 | 0

## Rules

Category | Rule | Violations | Severity
--- | --- | --- | ---
coding | MissingSwitchDefault | 1 | Warning
imports | CustomImportOrder sortImportsInGroupAlphabetically: `"true"` specialImportsRegExp: `"com.google"` customImportOrderRules: `"STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"` | 4 | Warning
javadoc | JavadocMethod scope: `"public"` allowMissingThrowsTags: `"true"` allowThrowsTagsForSubclasses: `"true"` allowMissingReturnTag: `"true"` allowMissingParamTags: `"true"` minLineCount: `"2"` allowedAnnotations: `"Override, Test"` | 12 | Warning
| JavadocParagraph | 5 | Warning
| NonEmptyAtclauseDescription | 1 | Warning
| SummaryJavadoc forbiddenSummaryFragments: `"^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"` | 7 | Warning
modifier | ModifierOrder | 1 | Warning
naming | AbbreviationAsWordInName ignoreFinal: `"false"` allowedAbbreviationLength: `"1"` | 11 | Warning
| CatchParameterName format: `"^[a-z][a-z0-9][a-zA-Z0-9]*$"` | 1 | Warning
| LocalVariableName format: `"^[a-z][a-z0-9][a-zA-Z0-9]*$"` allowOneCharVarInForLoop: `"true"` tokens: `"VARIABLE_DEF"` | 2 | Warning
| ParameterName format: `"^[a-z][a-z0-9][a-zA-Z0-9]*$"` | 7 | Warning
sizes | LineLength max: `"100"` ignorePattern: `"^package.*|^import.*|a href|href|http://|https://|ftp://"` | 16 | Warning
whitespace | EmptyLineSeparator allowNoEmptyLineBetweenFields: `"true"` | 1 | Warning
| OperatorWrap tokens: `"BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "` option: `"NL"` | 12 | Warning
| WhitespaceAround allowEmptyConstructors: `"true"` allowEmptyMethods: `"true"` allowEmptyLoops: `"true"` allowEmptyTypes: `"true"` | 22 | Warning

## Details

### com/ctrip/framework/apollo/Apollo.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | modifier | ModifierOrder | 'static' modifier out of order with the JLS suggestions. | 7

### com/ctrip/framework/apollo/core/MetaDomainConsts.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | imports | CustomImportOrder | Import statement for 'com.ctrip.framework.apollo.core.enums.Env' is in the wrong order. Should be in the 'THIRD_PARTY_PACKAGE' group, expecting not assigned imports on this line. | 7
Warning | imports | CustomImportOrder | Import statement for 'com.ctrip.framework.apollo.core.utils.ResourceUtils' is in the wrong order. Should be in the 'THIRD_PARTY_PACKAGE' group, expecting not assigned imports on this line. | 8
Warning | javadoc | JavadocParagraph | Empty line should be followed by <p> tag on the next line. | 13

### com/ctrip/framework/apollo/core/dto/ApolloConfig.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 23

### com/ctrip/framework/apollo/core/dto/ApolloConfigNotification.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 37
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 38
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 39

### com/ctrip/framework/apollo/core/dto/AppDTO.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | AbbreviationAsWordInName | Abbreviation in name 'AppDTO' must contain no more than '1' capital letters. | 3
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 3

### com/ctrip/framework/apollo/core/dto/AppNamespaceDTO.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | AbbreviationAsWordInName | Abbreviation in name 'AppNamespaceDTO' must contain no more than '1' capital letters. | 4
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 4
Warning | naming | ParameterName | Parameter name 'aPublic' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. | 53

### com/ctrip/framework/apollo/core/dto/BaseDTO.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | AbbreviationAsWordInName | Abbreviation in name 'BaseDTO' must contain no more than '1' capital letters. | 6

### com/ctrip/framework/apollo/core/dto/ClusterDTO.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | AbbreviationAsWordInName | Abbreviation in name 'ClusterDTO' must contain no more than '1' capital letters. | 3
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 3

### com/ctrip/framework/apollo/core/dto/CommitDTO.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | AbbreviationAsWordInName | Abbreviation in name 'CommitDTO' must contain no more than '1' capital letters. | 3
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 3

### com/ctrip/framework/apollo/core/dto/ItemChangeSets.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | javadoc | SummaryJavadoc | First sentence of Javadoc is incomplete (period is missing) or not present. | 6
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 9
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 27

### com/ctrip/framework/apollo/core/dto/ItemDTO.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | AbbreviationAsWordInName | Abbreviation in name 'ItemDTO' must contain no more than '1' capital letters. | 5
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 5
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 27
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 100
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 101
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 102
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 103
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 104
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 105
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 106
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 107
Warning | whitespace | OperatorWrap | '+' should be on a new line. | 108

### com/ctrip/framework/apollo/core/dto/NamespaceDTO.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | AbbreviationAsWordInName | Abbreviation in name 'NamespaceDTO' must contain no more than '1' capital letters. | 3
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 3

### com/ctrip/framework/apollo/core/dto/NamespaceLockDTO.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | AbbreviationAsWordInName | Abbreviation in name 'NamespaceLockDTO' must contain no more than '1' capital letters. | 3
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 3

### com/ctrip/framework/apollo/core/dto/ReleaseDTO.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | AbbreviationAsWordInName | Abbreviation in name 'ReleaseDTO' must contain no more than '1' capital letters. | 3
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 3

### com/ctrip/framework/apollo/core/dto/ServiceDTO.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | AbbreviationAsWordInName | Abbreviation in name 'ServiceDTO' must contain no more than '1' capital letters. | 3

### com/ctrip/framework/apollo/core/enums/ConfigFileFormat.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 21
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 21
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 22
Warning | coding | MissingSwitchDefault | switch without "default" clause. | 25
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 25

### com/ctrip/framework/apollo/core/enums/Env.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 6

### com/ctrip/framework/apollo/core/enums/EnvUtils.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 7

### com/ctrip/framework/apollo/core/exception/AbstractBaseException.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 3
Warning | javadoc | SummaryJavadoc | First sentence of Javadoc is incomplete (period is missing) or not present. | 5
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 16
Warning | naming | ParameterName | Parameter name 'e' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. | 20
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 20
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 24

### com/ctrip/framework/apollo/core/exception/BadRequestException.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | javadoc | SummaryJavadoc | First sentence of Javadoc is incomplete (period is missing) or not present. | 5

### com/ctrip/framework/apollo/core/exception/NotFoundException.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | javadoc | SummaryJavadoc | First sentence of Javadoc is incomplete (period is missing) or not present. | 4

### com/ctrip/framework/apollo/core/exception/ServiceException.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | javadoc | SummaryJavadoc | First sentence of Javadoc is incomplete (period is missing) or not present. | 5
Warning | naming | ParameterName | Parameter name 'e' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. | 14

### com/ctrip/framework/apollo/core/utils/ApolloThreadFactory.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 32
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 84

### com/ctrip/framework/apollo/core/utils/ByteUtil.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | ParameterName | Parameter name 'x' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. | 11
Warning | naming | ParameterName | Parameter name 'x' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. | 15
Warning | naming | ParameterName | Parameter name 'x' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. | 19
Warning | naming | ParameterName | Parameter name 'x' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. | 23
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 27
Warning | naming | LocalVariableName | Local variable name 'i' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. | 29

### com/ctrip/framework/apollo/core/utils/ClassLoaderUtil.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | CatchParameterName | Catch parameter name 'e' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. | 36

### com/ctrip/framework/apollo/core/utils/DNSUtil.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | AbbreviationAsWordInName | Abbreviation in name 'DNSUtil' must contain no more than '1' capital letters. | 8
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 10

### com/ctrip/framework/apollo/core/utils/MachineUtil.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | naming | LocalVariableName | Local variable name 'e' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. | 33

### com/ctrip/framework/apollo/core/utils/PropertiesUtil.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | javadoc | SummaryJavadoc | First sentence of Javadoc is incomplete (period is missing) or not present. | 11
Warning | javadoc | NonEmptyAtclauseDescription | At-clause should have a non-empty description. | 15
Warning | javadoc | SummaryJavadoc | First sentence of Javadoc is incomplete (period is missing) or not present. | 25

### com/ctrip/framework/apollo/core/utils/ResourceUtils.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | imports | CustomImportOrder | Import statement for 'org.slf4j.Logger' is in the wrong order. Should be in the 'THIRD_PARTY_PACKAGE' group, expecting not assigned imports on this line. | 12
Warning | imports | CustomImportOrder | Import statement for 'org.slf4j.LoggerFactory' is in the wrong order. Should be in the 'THIRD_PARTY_PACKAGE' group, expecting not assigned imports on this line. | 13
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 19

### com/ctrip/framework/apollo/core/utils/StringUtils.java

Severity | Category | Rule | Message | Line
--- | --- | --- | --- | ---
Warning | sizes | LineLength | Line is longer than 100 characters (found 128). | 24
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 35
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 35
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 36
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 40
Warning | whitespace | WhitespaceAround | WhitespaceAround: '{' is not preceded with whitespace. | 41
Warning | whitespace | EmptyLineSeparator | 'METHOD_DEF' should be separated from previous statement. | 64
Warning | javadoc | JavadocParagraph | <p> tag should be placed immediately before the first word, with no space after. | 78
Warning | javadoc | JavadocParagraph | Redundant <p> tag. | 78
Warning | sizes | LineLength | Line is longer than 100 characters (found 128). | 79
Warning | sizes | LineLength | Line is longer than 100 characters (found 127). | 83
Warning | sizes | LineLength | Line is longer than 100 characters (found 101). | 96
Warning | javadoc | JavadocParagraph | <p> tag should be placed immediately before the first word, with no space after. | 105
Warning | javadoc | JavadocParagraph | Redundant <p> tag. | 105
Warning | sizes | LineLength | Line is longer than 100 characters (found 131). | 106
Warning | sizes | LineLength | Line is longer than 100 characters (found 127). | 110
Warning | sizes | LineLength | Line is longer than 100 characters (found 118). | 132
Warning | sizes | LineLength | Line is longer than 100 characters (found 127). | 137
Warning | sizes | LineLength | Line is longer than 100 characters (found 131). | 166
Warning | sizes | LineLength | Line is longer than 100 characters (found 129). | 193
Warning | sizes | LineLength | Line is longer than 100 characters (found 131). | 220
Warning | sizes | LineLength | Line is longer than 100 characters (found 110). | 234
Warning | sizes | LineLength | Line is longer than 100 characters (found 131). | 269
Warning | sizes | LineLength | Line is longer than 100 characters (found 112). | 283
Warning | sizes | LineLength | Line is longer than 100 characters (found 113). | 293
Warning | sizes | LineLength | Line is longer than 100 characters (found 114). | 297
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 331
Warning | javadoc | JavadocMethod | Missing a Javadoc comment. | 340