Merge pull request spotify#407 from spotify/dxia/checkstyle-final-vars

checkstyle: Ensure local variables are final

Author: davidxia

checkstyle.xml

@@ -138,7 +138,11 @@ page at http://checkstyle.sourceforge.net/config.html -->
       <!-- Validates identifiers for local variables against the
         expression "^[a-z][a-zA-Z0-9]*$". -->
     </module>
-
+    <module name="FinalLocalVariable">
+      <!-- Checks that local variables that never have their values changed are declared final. -->
+      <property name="tokens" value="VARIABLE_DEF"/>
+      <property name="validateEnhancedForLoopVariable" value="true"/>
+    </module>
 
     <!--
 

pom.xml

@@ -219,7 +219,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>
-        <version>2.16</version>
+        <version>2.17</version>
         <executions>
           <execution>
             <id>validate</id>

src/main/java/com/spotify/docker/client/ApacheUnixSocket.java

@@ -147,7 +147,7 @@ private void setSocketOption(final SocketOptionSetter s) throws SocketException
   }
 
   private void setAllSocketOptions() throws SocketException {
-    for (SocketOptionSetter s : optionsToSet) {
+    for (final SocketOptionSetter s : optionsToSet) {
       s.run();
     }
   }

src/main/java/com/spotify/docker/client/CompressedDirectory.java

@@ -157,7 +157,7 @@ static ImmutableList<DockerIgnorePathMatcher> parseDockerIgnore(Path dockerIgnor
   }
 
   private static String createPattern(String line) {
-    String pattern = line.trim();
+    final String pattern = line.trim();
     if (pattern.startsWith("#")) {
       return null;
     }
@@ -287,12 +287,9 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IO
      * @return <code>true</code> if the given path should be excluded, <code>false</code> otherwise
      */
     private static boolean exclude(ImmutableList<DockerIgnorePathMatcher> matchers, Path path) {
-      for (DockerIgnorePathMatcher matcher : matchers) {
+      for (final DockerIgnorePathMatcher matcher : matchers) {
         if (matcher.matches(path)) {
-          if (matcher.isExclude()) {
-            return true;
-          }
-          return false;
+          return matcher.isExclude();
         }
       }
       return false;
@@ -315,12 +312,15 @@ private static int getPosixFileMode(Path file) throws IOException {
       final Set<PosixFilePermission> perm = attr.permissions();
 
       // retain permissions, note these values are octal
+      //noinspection OctalInteger
       int mode = 0100000;
+      //noinspection OctalInteger
       mode += 0100 * getModeFromPermissions(
           perm.contains(PosixFilePermission.OWNER_READ),
           perm.contains(PosixFilePermission.OWNER_WRITE),
           perm.contains(PosixFilePermission.OWNER_EXECUTE));
 
+      //noinspection OctalInteger
       mode += 010 * getModeFromPermissions(
           perm.contains(PosixFilePermission.GROUP_READ),
           perm.contains(PosixFilePermission.GROUP_WRITE),

src/main/java/com/spotify/docker/client/DefaultDockerClient.java

@@ -277,7 +277,7 @@ protected DefaultDockerClient(final Builder builder) {
 
   @VisibleForTesting
   DefaultDockerClient(final Builder builder, Supplier<ClientBuilder> clientBuilderSupplier) {
-    URI originalUri = checkNotNull(builder.uri, "uri");
+    final URI originalUri = checkNotNull(builder.uri, "uri");
     this.apiVersion = builder.apiVersion();
 
     if ((builder.dockerCertificates != null) && !originalUri.getScheme().equals("https")) {
@@ -400,7 +400,7 @@ public List<Container> listContainers(final ListContainersParam... params)
         .path("containers").path("json");
 
     final Map<String, List<String>> filters = newHashMap();
-    for (ListContainersParam param : params) {
+    for (final ListContainersParam param : params) {
       if (param instanceof ListContainersFilterParam) {
         List<String> filterValueList;
         if (filters.containsKey(param.name())) {
@@ -467,9 +467,9 @@ public List<Image> listImages(final ListImagesParam... params)
         .path("images").path("json");
 
     final Map<String, List<String>> filters = newHashMap();
-    for (ListImagesParam param : params) {
+    for (final ListImagesParam param : params) {
       if (param instanceof ListImagesFilterParam) {
-        List<String> filterValueList;
+        final List<String> filterValueList;
         if (filters.containsKey(param.name())) {
           filterValueList = filters.get(param.name());
         } else {
@@ -686,7 +686,7 @@ public InputStream copyContainer(String containerId, String path)
         .path("containers").path(containerId).path("copy");
 
     // Internal JSON object; not worth it to create class for this
-    JsonNodeFactory nf = JsonNodeFactory.instance;
+    final JsonNodeFactory nf = JsonNodeFactory.instance;
     final JsonNode params = nf.objectNode().set("Resource", nf.textNode(path));
 
     return request(POST, InputStream.class, resource,
@@ -704,11 +704,9 @@ public void copyToContainer(final Path directory, String containerId, String pat
         .queryParam("noOverwriteDirNonDir", true)
         .queryParam("path", path);
 
-    CompressedDirectory compressedDirectory
-        = CompressedDirectory.create(directory);
+    final CompressedDirectory compressedDirectory = CompressedDirectory.create(directory);
 
-    final InputStream fileStream =
-        Files.newInputStream(compressedDirectory.file());
+    final InputStream fileStream = Files.newInputStream(compressedDirectory.file());
 
     request(PUT, String.class, resource,
             resource.request(APPLICATION_OCTET_STREAM_TYPE),
@@ -845,9 +843,10 @@ public void load(final String image, final InputStream imagePayload,
         .queryParam("fromSrc", "-")
         .queryParam("tag", image);
 
-    LoadProgressHandler loadProgressHandler = new LoadProgressHandler(handler);
-    Entity<InputStream> entity = Entity.entity(imagePayload, MediaType.APPLICATION_OCTET_STREAM);
-    try (ProgressStream load =
+    final LoadProgressHandler loadProgressHandler = new LoadProgressHandler(handler);
+    final Entity<InputStream> entity = Entity.entity(imagePayload,
+                                                     MediaType.APPLICATION_OCTET_STREAM);
+    try (final ProgressStream load =
              request(POST, ProgressStream.class, resource,
                      resource
                          .request(APPLICATION_JSON_TYPE)
@@ -870,7 +869,7 @@ public InputStream save(final String image)
   @Override
   public InputStream save(final String image, final AuthConfig authConfig)
       throws DockerException, IOException, InterruptedException {
-    WebTarget resource = resource().path("images").path(image).path("get");
+    final WebTarget resource = resource().path("images").path(image).path("get");
 
     return request(
         GET,
@@ -1108,7 +1107,7 @@ public LogStream logs(final String containerId, final LogsParam... params)
         .path("containers").path(containerId)
         .path("logs");
 
-    for (LogsParam param : params) {
+    for (final LogsParam param : params) {
       resource = resource.queryParam(param.name(), param.value());
     }
 
@@ -1120,7 +1119,7 @@ public EventStream events(EventsParam... params)
       throws DockerException, InterruptedException {
     WebTarget resource = noTimeoutResource().path("events");
     final Map<String, String> filters = newHashMap();
-    for (EventsParam param : params) {
+    for (final EventsParam param : params) {
       if (param instanceof EventsFilterParam) {
         filters.put(param.name(), param.value());
       } else {
@@ -1133,7 +1132,7 @@ public EventStream events(EventsParam... params)
         final StringWriter writer = new StringWriter();
         final JsonGenerator generator = objectMapper().getFactory().createGenerator(writer);
         generator.writeStartObject();
-        for (Map.Entry<String, String> entry : filters.entrySet()) {
+        for (final Map.Entry<String, String> entry : filters.entrySet()) {
           generator.writeArrayFieldStart(entry.getKey());
           generator.writeString(entry.getValue());
           generator.writeEndArray();
@@ -1149,9 +1148,9 @@ public EventStream events(EventsParam... params)
     }
 
     try {
-      CloseableHttpClient client = (CloseableHttpClient) ApacheConnectorProvider
+      final CloseableHttpClient client = (CloseableHttpClient) ApacheConnectorProvider
           .getHttpClient(noTimeoutClient);
-      CloseableHttpResponse response = client.execute(new HttpGet(resource.getUri()));
+      final CloseableHttpResponse response = client.execute(new HttpGet(resource.getUri()));
       return new EventStream(response, objectMapper());
     } catch (IOException exception) {
       throw new DockerException(exception);
@@ -1192,7 +1191,7 @@ public String execCreate(final String containerId,
                            final String[] cmd,
                            final ExecCreateParam... params)
       throws DockerException, InterruptedException {
-    WebTarget resource = resource().path("containers").path(containerId).path("exec");
+    final WebTarget resource = resource().path("containers").path(containerId).path("exec");
 
     final StringWriter writer = new StringWriter();
     try {
@@ -1233,7 +1232,7 @@ public String execCreate(final String containerId,
     }
 
     try {
-      JsonNode json = objectMapper().readTree(response);
+      final JsonNode json = objectMapper().readTree(response);
       return json.findValue("Id").textValue();
     } catch (IOException e) {
       throw new DockerException(e);
@@ -1244,14 +1243,14 @@ public String execCreate(final String containerId,
   @Override
   public LogStream execStart(final String execId, final ExecStartParameter... params)
       throws DockerException, InterruptedException {
-    WebTarget resource = resource().path("exec").path(execId).path("start");
+    final WebTarget resource = resource().path("exec").path(execId).path("start");
 
     final StringWriter writer = new StringWriter();
     try {
       final JsonGenerator generator = objectMapper().getFactory().createGenerator(writer);
       generator.writeStartObject();
 
-      for (ExecStartParameter param : params) {
+      for (final ExecStartParameter param : params) {
         generator.writeBooleanField(param.getName(), true);
       }
 
@@ -1277,7 +1276,7 @@ public LogStream execStart(final String execId, final ExecStartParameter... para
 
   @Override
   public ExecState execInspect(final String execId) throws DockerException, InterruptedException {
-    WebTarget resource = resource().path("exec").path(execId).path("json");
+    final WebTarget resource = resource().path("exec").path(execId).path("json");
 
     try {
       return request(GET, ExecState.class, resource, resource.request(APPLICATION_JSON_TYPE));
@@ -1370,9 +1369,9 @@ private void manageNetworkConnection(String containerId, String methodname, Stri
       throws DockerException, InterruptedException {
     final WebTarget resource = resource().path("networks").path(networkId).path(methodname);
 
-    Map<String, String> request = new HashMap<>();
+    final Map<String, String> request = new HashMap<>();
     request.put("Container", containerId);
-    Response response =
+    final Response response =
         request(POST, Response.class, resource, resource.request(APPLICATION_JSON_TYPE),
                 Entity.json(request));
     switch (response.getStatus()) {
@@ -1444,9 +1443,9 @@ private void request(final String method,
   }
 
   private Invocation.Builder headers(final Invocation.Builder request) {
-    Set<Map.Entry<String, Object>> entries = headers.entrySet();
+    final Set<Map.Entry<String, Object>> entries = headers.entrySet();
 
-    for (Map.Entry<String, Object> entry : entries) {
+    for (final Map.Entry<String, Object> entry : entries) {
       request.header(entry.getKey(), entry.getValue());
     }
 
@@ -1537,7 +1536,7 @@ private String authRegistryHeader(final AuthRegistryConfig authRegistryConfig)
       }
 
       log.debug("Registry Config Json {}", authRegistryJson);
-      String authRegistryEncoded = Base64.encodeAsString(authRegistryJson);
+      final String authRegistryEncoded = Base64.encodeAsString(authRegistryJson);
       log.debug("Registry Config Encoded {}", authRegistryEncoded);
       return authRegistryEncoded;
     } catch (JsonProcessingException | InterruptedException ex) {

src/main/java/com/spotify/docker/client/DockerClient.java

@@ -538,7 +538,7 @@ public boolean equals(Object o) {
         return false;
       }
 
-      BuildParam that = (BuildParam) o;
+      final BuildParam that = (BuildParam) o;
 
       if (name != null ? !name.equals(that.name) : that.name != null) {
         return false;

src/main/java/com/spotify/docker/client/LogStream.java

@@ -77,7 +77,7 @@ public void close() {
   }
 
   public String readFully() {
-    StringBuilder stringBuilder = new StringBuilder();
+    final StringBuilder stringBuilder = new StringBuilder();
     while (hasNext()) {
       stringBuilder.append(UTF_8.decode(next().content()));
     }

src/main/java/com/spotify/docker/client/VersionCompare.java

@@ -37,16 +37,16 @@ private VersionCompare() {
    * "1.10.0".
    */
   public static int compareVersion(String str1, String str2) {
-    String[] vals1 = str1.split("\\.");
-    String[] vals2 = str2.split("\\.");
+    final String[] vals1 = str1.split("\\.");
+    final String[] vals2 = str2.split("\\.");
     int i = 0;
     // set index to first non-equal ordinal or length of shortest version string
     while (i < vals1.length && i < vals2.length && vals1[i].equals(vals2[i])) {
       i++;
     }
     // compare first non-equal ordinal number
     if (i < vals1.length && i < vals2.length) {
-      int diff = Integer.valueOf(vals1[i]).compareTo(Integer.valueOf(vals2[i]));
+      final int diff = Integer.valueOf(vals1[i]).compareTo(Integer.valueOf(vals2[i]));
       return Integer.signum(diff);
     } else {
       // the strings are equal or one string is a substring of the other

src/main/java/com/spotify/docker/client/messages/AttachedNetwork.java

@@ -80,7 +80,7 @@ public boolean equals(Object o) {
       return false;
     }
 
-    AttachedNetwork that = (AttachedNetwork) o;
+    final AttachedNetwork that = (AttachedNetwork) o;
 
     return Objects.equals(this.endpointId, that.endpointId) &&
            Objects.equals(this.gateway, that.gateway) &&

src/main/java/com/spotify/docker/client/messages/ContainerInfo.java

@@ -329,7 +329,7 @@ public boolean equals(Object o) {
       if (o == null || getClass() != o.getClass()) {
         return false;
       }
-      Node node = (Node) o;
+      final Node node = (Node) o;
       return Objects.equals(id, node.id) &&
              Objects.equals(ip, node.ip) &&
              Objects.equals(addr, node.addr) &&

src/main/java/com/spotify/docker/client/messages/ContainerStats.java

@@ -84,7 +84,7 @@ public boolean equals(Object obj) {
     if (getClass() != obj.getClass()) {
       return false;
     }
-    ContainerStats other = (ContainerStats) obj;
+    final ContainerStats other = (ContainerStats) obj;
     if (cpuStats == null) {
       if (other.cpuStats != null) {
         return false;

src/main/java/com/spotify/docker/client/messages/CpuStats.java

@@ -59,7 +59,7 @@ public boolean equals(Object obj) {
     if (getClass() != obj.getClass()) {
       return false;
     }
-    CpuStats other = (CpuStats) obj;
+    final CpuStats other = (CpuStats) obj;
     if (cpuUsage == null) {
       if (other.cpuUsage != null) {
         return false;

src/main/java/com/spotify/docker/client/messages/CpuUsage.java

@@ -72,7 +72,7 @@ public boolean equals(Object obj) {
     if (getClass() != obj.getClass()) {
       return false;
     }
-    CpuUsage other = (CpuUsage) obj;
+    final CpuUsage other = (CpuUsage) obj;
     if (percpuUsage == null) {
       if (other.percpuUsage != null) {
         return false;

src/main/java/com/spotify/docker/client/messages/HostConfig.java

@@ -434,7 +434,7 @@ public boolean equals(Object o) {
         return false;
       }
 
-      RestartPolicy that = (RestartPolicy) o;
+      final RestartPolicy that = (RestartPolicy) o;
 
       if (name != null ? !name.equals(that.name) : that.name != null) {
         return false;

src/main/java/com/spotify/docker/client/messages/Image.java

@@ -79,7 +79,7 @@ public boolean equals(Object o) {
       return false;
     }
 
-    Image that = (Image) o;
+    final Image that = (Image) o;
 
     return Objects.equals(this.created, that.created) &&
            Objects.equals(this.id, that.id) &&

src/main/java/com/spotify/docker/client/messages/Info.java

@@ -156,7 +156,7 @@ public boolean equals(Object o) {
       return false;
     }
 
-    Info info = (Info) o;
+    final Info info = (Info) o;
 
     if (containers != info.containers) {
       return false;

src/main/java/com/spotify/docker/client/messages/Ipam.java

@@ -61,7 +61,7 @@ public boolean equals(Object o) {
       return false;
     }
 
-    Ipam that = (Ipam) o;
+    final Ipam that = (Ipam) o;
 
     return Objects.equals(this.driver, that.driver) && Objects.equals(this.config, that.config);
   }
@@ -93,7 +93,7 @@ public Builder driver(final String driver) {
     }
 
     public Builder config(final String subnet, final String ipRange, final String gateway) {
-      IpamConfig config = new IpamConfig();
+      final IpamConfig config = new IpamConfig();
       config.subnet(subnet);
       config.ipRange(ipRange);
       config.gateway(gateway);

src/main/java/com/spotify/docker/client/messages/IpamConfig.java

@@ -67,7 +67,7 @@ public boolean equals(Object o) {
       return false;
     }
 
-    IpamConfig that = (IpamConfig) o;
+    final IpamConfig that = (IpamConfig) o;
 
     return Objects.equals(this.subnet, that.subnet) &&
            Objects.equals(this.ipRange, that.ipRange) &&