Skip to content

Commit

Permalink
Introduce checkstyle to enforce code style. Clean-up files to pass.
Browse files Browse the repository at this point in the history
  • Loading branch information
@JakeWharton
JakeWharton committed May 18, 2012
1 parent 44e7c9c commit 704f59d
Show file tree
Hide file tree
Showing 19 changed files with 257 additions and 40 deletions.
6 changes: 3 additions & 3 deletions .gitignore
View file
Expand Up @@ -13,9 +13,9 @@ target
pom.xml.*
release.properties

.idea/workspace.xml
.idea/tasks.xml
.idea/libraries
.idea
*.iml
classes

obj

Expand Down
20 changes: 20 additions & 0 deletions android/pom.xml
View file
Expand Up @@ -28,4 +28,24 @@
<scope>test</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<configuration>
<configLocation>../checkstyle.xml</configLocation>
</configuration>
<executions>
<execution>
<phase>verify</phase>
<goals>
<goal>checkstyle</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
4 changes: 2 additions & 2 deletions android/src/main/java/retrofit/android/ShakeDetector.java
View file
Expand Up @@ -154,8 +154,8 @@ void clear() {

/** Purges samples with timestamps older than cutoff. */
void purge(long cutoff) {
while (sampleCount >= MIN_QUEUE_SIZE &&
oldest != null && cutoff - oldest.timestamp > 0) {
while (sampleCount >= MIN_QUEUE_SIZE
&& oldest != null && cutoff - oldest.timestamp > 0) {
// Remove sample.
Sample removed = oldest;
if (removed.accelerating) acceleratingCount--;
Expand Down
9 changes: 5 additions & 4 deletions android/src/main/java/retrofit/io/QueueFile.java
View file
Expand Up @@ -50,7 +50,7 @@
* @author Bob Lee (bob@squareup.com)
*/
public class QueueFile {
private static final Logger logger =
private static final Logger LOGGER =
Logger.getLogger(QueueFile.class.getName());

/** Initial file size in bytes. */
Expand Down Expand Up @@ -501,7 +501,8 @@ public synchronized void remove() throws IOException {
public synchronized void clear() throws IOException {
writeHeader(INITIAL_LENGTH, 0, 0, 0);
elementCount = 0;
first = last = Element.NULL;
first = Element.NULL;
last = Element.NULL;
fileLength = INITIAL_LENGTH;
if (fileLength > INITIAL_LENGTH) setLength(INITIAL_LENGTH);
}
Expand Down Expand Up @@ -533,7 +534,7 @@ public synchronized void close() throws IOException {
}
});
} catch (IOException e) {
logger.log(Level.WARNING, "read error", e);
LOGGER.log(Level.WARNING, "read error", e);
}
builder.append("]]");
return builder.toString();
Expand Down Expand Up @@ -590,6 +591,6 @@ public interface ElementReader {
* which case it reads all the remaining bytes. Not buffered.
* @param length of element data in bytes
*/
public void read(InputStream in, int length) throws IOException;
void read(InputStream in, int length) throws IOException;
}
}
120 changes: 120 additions & 0 deletions checkstyle.xml
View file
@@ -0,0 +1,120 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.2//EN"
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">

<module name="Checker">
<!--module name="NewlineAtEndOfFile"/-->
<module name="FileLength"/>
<module name="FileTabCharacter"/>

<!-- Trailing spaces -->
<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="message" value="Line has trailing spaces."/>
</module>

<module name="TreeWalker">
<property name="cacheFile" value="${checkstyle.cache.file}"/>

<!-- Checks for Javadoc comments. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
<!--module name="JavadocMethod"/-->
<!--module name="JavadocType"/-->
<!--module name="JavadocVariable"/-->
<!--module name="JavadocStyle"/-->


<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle.sf.net/config_naming.html -->
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>


<!-- Checks for imports -->
<!-- See http://checkstyle.sf.net/config_import.html -->
<module name="AvoidStarImport"/>
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<module name="RedundantImport"/>
<module name="UnusedImports"/>


<!-- Checks for Size Violations. -->
<!-- See http://checkstyle.sf.net/config_sizes.html -->
<module name="LineLength">
<property name="max" value="120"/>
</module>
<!--module name="MethodLength"/-->
<!--module name="ParameterNumber"/-->


<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="GenericWhitespace"/>
<module name="EmptyForIteratorPad"/>
<module name="MethodParamPad"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="OperatorWrap"/>
<module name="ParenPad"/>
<!--module name="TypecastParenPad"/-->
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>


<!-- Modifier Checks -->
<!-- See http://checkstyle.sf.net/config_modifiers.html -->
<!--module name="ModifierOrder"/-->
<module name="RedundantModifier"/>


<!-- Checks for blocks. You know, those {}'s -->
<!-- See http://checkstyle.sf.net/config_blocks.html -->
<!--module name="AvoidNestedBlocks"/-->
<!--module name="EmptyBlock"/-->
<module name="LeftCurly"/>
<!--module name="NeedBraces"/-->
<module name="RightCurly"/>


<!-- Checks for common coding problems -->
<!-- See http://checkstyle.sf.net/config_coding.html -->
<!--module name="AvoidInlineConditionals"/-->
<module name="CovariantEquals"/>
<module name="DoubleCheckedLocking"/>
<module name="EmptyStatement"/>
<module name="EqualsAvoidNull"/>
<module name="EqualsHashCode"/>
<!--module name="HiddenField"/-->
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<!--module name="MagicNumber"/-->
<module name="MissingSwitchDefault"/>
<module name="RedundantThrows"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>

<!-- Checks for class design -->
<!-- See http://checkstyle.sf.net/config_design.html -->
<!--module name="DesignForExtension"/-->
<!--module name="FinalClass"/-->
<!--module name="HideUtilityClassConstructor"/-->
<!--module name="InterfaceIsType"/-->
<!--module name="VisibilityModifier"/-->


<!-- Miscellaneous other checks. -->
<!-- See http://checkstyle.sf.net/config_misc.html -->
<!--module name="ArrayTypeStyle"/-->
<!--module name="FinalParameters"/-->
<!--module name="TodoComment"/-->
<module name="UpperEll"/>
</module>
</module>
20 changes: 20 additions & 0 deletions core/pom.xml
View file
Expand Up @@ -22,4 +22,24 @@
<scope>test</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<configuration>
<configLocation>../checkstyle.xml</configLocation>
</configuration>
<executions>
<execution>
<phase>verify</phase>
<goals>
<goal>checkstyle</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
16 changes: 16 additions & 0 deletions http/pom.xml
View file
Expand Up @@ -53,6 +53,22 @@

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<configuration>
<configLocation>../checkstyle.xml</configLocation>
</configuration>
<executions>
<execution>
<phase>verify</phase>
<goals>
<goal>checkstyle</goal>
</goals>
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>jarjar-maven-plugin</artifactId>
Expand Down
22 changes: 11 additions & 11 deletions http/src/main/java/retrofit/http/CallbackResponseHandler.java
View file
Expand Up @@ -21,7 +21,7 @@
public abstract class CallbackResponseHandler<T>
implements ResponseHandler<Void> {

private static final Logger logger =
private static final Logger LOGGER =
Logger.getLogger(CallbackResponseHandler.class.getName());

private static final int UNAUTHORIZED = 401;
Expand Down Expand Up @@ -66,13 +66,13 @@ public Void handleResponse(HttpResponse response) throws IOException {
int statusCode = statusLine.getStatusCode();

if (statusCode == UNAUTHORIZED) {
logger.fine("Session expired.");
LOGGER.fine("Session expired.");
callback.sessionExpired();
return null;
}

if (statusCode == FORBIDDEN) {
logger.fine("Account disabled.");
LOGGER.fine("Account disabled.");
callback.sessionExpired();
return null;
}
Expand All @@ -82,15 +82,15 @@ public Void handleResponse(HttpResponse response) throws IOException {
// 2XX == successful request
if (statusCode >= 200 && statusCode < 300) {
if (entity == null) {
logger.fine("Missing entity for " + statusCode + " response.");
LOGGER.fine("Missing entity for " + statusCode + " response.");
callback.serverError(null, statusCode);
return null;
}

try {
callback.call(parse(entity));
} catch (ServerException e) {
logger.log(Level.WARNING, e.getMessage(), e);
LOGGER.log(Level.WARNING, e.getMessage(), e);
callback.serverError(null, statusCode);
}
return null;
Expand All @@ -101,11 +101,11 @@ public Void handleResponse(HttpResponse response) throws IOException {
if (entity != null) {
// TODO: Use specified encoding.
String body = new String(HttpClients.entityToBytes(entity), "UTF-8");
logger.fine("Server returned " + statusCode + ", "
LOGGER.fine("Server returned " + statusCode + ", "
+ statusLine.getReasonPhrase() + ". Body: " + body);
callback.serverError(parseServerMessage(statusCode, body), statusCode);
} else {
logger.fine("Server returned " + statusCode + ", "
LOGGER.fine("Server returned " + statusCode + ", "
+ statusLine.getReasonPhrase() + ".");
callback.serverError(null, statusCode);
}
Expand All @@ -119,16 +119,16 @@ public Void handleResponse(HttpResponse response) throws IOException {
// TODO: Use specified encoding.
String body = new String(HttpClients.entityToBytes(bufferedEntity),
"UTF-8");
logger.fine("Server returned " + statusCode + ", "
LOGGER.fine("Server returned " + statusCode + ", "
+ statusLine.getReasonPhrase() + ". Body: " + body);
try {
callback.clientError(parse(bufferedEntity), statusCode);
} catch (ServerException e) {
logger.log(Level.WARNING, e.getMessage(), e);
LOGGER.log(Level.WARNING, e.getMessage(), e);
callback.serverError(null, statusCode);
}
} else {
logger.fine("Server returned " + statusCode + ", "
LOGGER.fine("Server returned " + statusCode + ", "
+ statusLine.getReasonPhrase() + ".");
callback.clientError(null, statusCode);
}
Expand All @@ -146,7 +146,7 @@ private String parseServerMessage(int statusCode, String body) {
if (serverError != null) return serverError.message;
} catch (Throwable t) {
// The server error takes precedence.
logger.log(Level.WARNING, t.getMessage(), t);
LOGGER.log(Level.WARNING, t.getMessage(), t);
}
}
return null;
Expand Down
4 changes: 2 additions & 2 deletions http/src/main/java/retrofit/http/Fetcher.java
View file
Expand Up @@ -25,7 +25,7 @@
* @author Bob Lee (bob@squareup.com)
*/
public class Fetcher {
private static final Logger logger =
private static final Logger LOGGER =
Logger.getLogger(Fetcher.class.getName());

// TODO: Support conditional get.
Expand Down Expand Up @@ -62,7 +62,7 @@ public void run() {
httpClientProvider.get().execute(get, new DownloadHandler(gson, destination,
uiCallback, progressListener, mainThread));
} catch (IOException e) {
logger.log(Level.WARNING, "fetch exception", e);
LOGGER.log(Level.WARNING, "fetch exception", e);
uiCallback.networkError();
} catch (Throwable t) {
uiCallback.unexpectedError(t);
Expand Down
4 changes: 2 additions & 2 deletions http/src/main/java/retrofit/http/GsonResponseHandler.java
View file
Expand Up @@ -15,7 +15,7 @@
* Callback#call(T)}.
*/
class GsonResponseHandler<T> extends CallbackResponseHandler<T> {
private static final Logger logger =
private static final Logger LOGGER =
Logger.getLogger(GsonResponseHandler.class.getName());

private final Gson gson;
Expand All @@ -40,7 +40,7 @@ static <T> GsonResponseHandler<T> create(Gson gson, Type type, Callback<T> callb
@Override protected T parse(HttpEntity entity) throws IOException,
ServerException {
try {
if (logger.isLoggable(Level.FINE)) {
if (LOGGER.isLoggable(Level.FINE)) {
entity = HttpClients.copyAndLog(entity, url, startTime);
}

Expand Down
2 changes: 1 addition & 1 deletion http/src/main/java/retrofit/http/Headers.java
View file
Expand Up @@ -11,5 +11,5 @@
public interface Headers {

/** Sets headers on the given message, with the specified MIME type */
public void setOn(HttpMessage message, String mimeType);
void setOn(HttpMessage message, String mimeType);
}

0 comments on commit 704f59d

Please sign in to comment.