Fix checkstyle issues to enforce it 22/63022/1
authorDavid Suarez <david.suarez.fuentes@gmail.com>
Tue, 12 Sep 2017 08:28:59 +0000 (10:28 +0200)
committerDavid Suarez <david.suarez.fuentes@gmail.com>
Tue, 12 Sep 2017 08:28:59 +0000 (10:28 +0200)
Fix checkstyle issues to enforce it.

Change-Id: Ic1c79114162d0c9772479e98df628d09daaa623b
Signed-off-by: David Suarez <david.suarez.fuentes@gmail.com>
opendaylight/config/config-persister-directory-xml-adapter/pom.xml
opendaylight/config/config-persister-directory-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/directory/xml/XmlDirectoryPersister.java
opendaylight/config/config-persister-directory-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/directory/xml/XmlDirectoryStorageAdapter.java
opendaylight/config/config-persister-directory-xml-adapter/src/test/java/org/opendaylight/controller/config/persist/storage/directory/xml/DirectoryStorageAdapterTest.java

index 1fb37450de6dfb7a905c9d95af0fd2a1f92dbb3f..29c539a7339e20e4326162056e0e69cbbd89d5aa 100644 (file)
 
   <build>
     <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-checkstyle-plugin</artifactId>
+        <configuration>
+          <propertyExpansion>checkstyle.violationSeverity=error</propertyExpansion>
+        </configuration>
+      </plugin>
       <plugin>
         <groupId>org.apache.felix</groupId>
         <artifactId>maven-bundle-plugin</artifactId>
index ae7954f76a6147803d57496bf6363736e30d49b4..da4fbfbd2303b9749b186ae86d2fdf0529d1c454 100644 (file)
@@ -11,6 +11,7 @@ import static com.google.common.base.Preconditions.checkArgument;
 
 import com.google.common.base.Optional;
 import com.google.common.io.Files;
+
 import java.io.File;
 import java.io.FilenameFilter;
 import java.io.IOException;
@@ -20,6 +21,7 @@ import java.util.Collections;
 import java.util.List;
 import java.util.Set;
 import java.util.SortedSet;
+
 import javax.xml.bind.JAXBContext;
 import javax.xml.bind.JAXBException;
 import javax.xml.bind.Unmarshaller;
@@ -27,6 +29,7 @@ import javax.xml.stream.XMLInputFactory;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
 import javax.xml.transform.stream.StreamSource;
+
 import org.opendaylight.controller.config.persist.api.ConfigSnapshotHolder;
 import org.opendaylight.controller.config.persist.api.Persister;
 import org.opendaylight.controller.config.persist.storage.file.xml.model.ConfigSnapshot;
@@ -40,14 +43,14 @@ public class XmlDirectoryPersister implements Persister {
     private final Optional<FilenameFilter> extensionsFilter;
 
     /**
-     * Creates XmlDirectoryPersister that picks up all files in specified folder
+     * Creates XmlDirectoryPersister that picks up all files in specified folder.
      */
     public XmlDirectoryPersister(final File storage) {
         this(storage, Optional.<FilenameFilter>absent());
     }
 
     /**
-     * Creates XmlDirectoryPersister that picks up files only with specified file extension
+     * Creates XmlDirectoryPersister that picks up files only with specified file extension.
      */
     public XmlDirectoryPersister(final File storage, final Set<String> fileExtensions) {
         this(storage, Optional.of(getFilter(fileExtensions)));
@@ -66,7 +69,8 @@ public class XmlDirectoryPersister implements Persister {
 
     @Override
     public List<ConfigSnapshotHolder> loadLastConfigs() throws IOException {
-        File[] filesArray = extensionsFilter.isPresent() ? storage.listFiles(extensionsFilter.get()) : storage.listFiles();
+        File[] filesArray =
+                extensionsFilter.isPresent() ? storage.listFiles(extensionsFilter.get()) : storage.listFiles();
         if (filesArray == null || filesArray.length == 0) {
             return Collections.emptyList();
         }
@@ -78,13 +82,13 @@ public class XmlDirectoryPersister implements Persister {
         List<ConfigSnapshotHolder> result = new ArrayList<>();
         for (File file : sortedFiles) {
             LOG.trace("Adding file '{}' to combined result", file);
-            Optional<ConfigSnapshotHolder> h = fromXmlSnapshot(file);
+            Optional<ConfigSnapshotHolder> configSnapshotHolderOptional = fromXmlSnapshot(file);
             // Ignore non valid snapshot
-            if(h.isPresent() == false) {
+            if (!configSnapshotHolderOptional.isPresent()) {
                 continue;
             }
 
-            result.add(h.get());
+            result.add(configSnapshotHolderOptional.get());
         }
         return result;
     }
@@ -95,7 +99,8 @@ public class XmlDirectoryPersister implements Persister {
         } catch (final JAXBException e) {
             // In case of parse error, issue a warning, ignore and continue
             LOG.warn(
-                    "Unable to parse configuration snapshot from {}. Initial config from {} will be IGNORED in this run. ",
+                    "Unable to parse configuration snapshot from {}. "
+                            + "Initial config from {} will be IGNORED in this run. ",
                     file, file);
             LOG.warn(
                     "Note that subsequent config files may fail due to this problem. ",
@@ -139,8 +144,8 @@ public class XmlDirectoryPersister implements Persister {
         };
     }
 
-    private static FilenameFilter getFilter(final Set<String>fileExtensions) {
-        checkArgument(fileExtensions.isEmpty() == false, "No file extension provided", fileExtensions);
+    private static FilenameFilter getFilter(final Set<String> fileExtensions) {
+        checkArgument(!fileExtensions.isEmpty(), "No file extension provided", fileExtensions);
 
         return (dir, name) -> {
             String ext = Files.getFileExtension(name);
@@ -150,7 +155,6 @@ public class XmlDirectoryPersister implements Persister {
 
     @Override
     public void close() {
-
     }
 
     @Override
index 42ab93b585f32254269c8522584c8fe638ba5652..576a24a41f55a8c00b138b8b38457bf273a47f6c 100644 (file)
@@ -11,8 +11,10 @@ package org.opendaylight.controller.config.persist.storage.directory.xml;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Splitter;
 import com.google.common.collect.Sets;
+
 import java.io.File;
 import java.util.Set;
+
 import org.opendaylight.controller.config.persist.api.Persister;
 import org.opendaylight.controller.config.persist.api.PropertiesProvider;
 import org.opendaylight.controller.config.persist.api.StorageAdapter;
@@ -30,17 +32,17 @@ public class XmlDirectoryStorageAdapter implements StorageAdapter {
     public static final String INCLUDE_EXT_PROP = "includeExtensions";
     private static final char EXTENSIONS_SEPARATOR = ',';
 
-
     @Override
     public Persister instantiate(final PropertiesProvider propertiesProvider) {
         String fileStorageProperty = propertiesProvider.getProperty(DIRECTORY_STORAGE_PROP);
-        Preconditions.checkNotNull(fileStorageProperty, "Unable to find " + propertiesProvider.getFullKeyForReporting(DIRECTORY_STORAGE_PROP));
-        File storage  = new File(fileStorageProperty);
+        Preconditions.checkNotNull(fileStorageProperty,
+                "Unable to find " + propertiesProvider.getFullKeyForReporting(DIRECTORY_STORAGE_PROP));
+        File storage = new File(fileStorageProperty);
         String fileExtensions = propertiesProvider.getProperty(INCLUDE_EXT_PROP);
 
         LOG.debug("Using storage: {}", storage);
 
-        if(fileExtensions != null) {
+        if (fileExtensions != null) {
             LOG.debug("Using extensions: {}", fileExtensions);
             return new XmlDirectoryPersister(storage, splitExtensions(fileExtensions));
         } else {
@@ -52,5 +54,4 @@ public class XmlDirectoryStorageAdapter implements StorageAdapter {
         return Sets.newHashSet(Splitter.on(EXTENSIONS_SEPARATOR).trimResults().omitEmptyStrings()
                 .split(fileExtensions));
     }
-
 }
index 6aca047dec24554dbd9ad455a7db960040ae8e79..1142e060aaa0ae19e736098750b1615dcfc37cbf 100644 (file)
@@ -14,11 +14,13 @@ import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 
 import com.google.common.base.Optional;
+
 import java.io.File;
 import java.io.IOException;
 import java.util.Collections;
 import java.util.List;
 import java.util.SortedSet;
+
 import org.junit.Test;
 import org.opendaylight.controller.config.persist.api.ConfigSnapshotHolder;
 import org.opendaylight.controller.config.persist.api.Persister;
@@ -31,10 +33,10 @@ public class DirectoryStorageAdapterTest {
     private static final Logger LOG = LoggerFactory.getLogger(DirectoryStorageAdapterTest.class);
     Persister tested;
 
-    private Persister instantiatePersisterFromAdapter(final File file, final Optional<String> extensions){
+    private Persister instantiatePersisterFromAdapter(final File file, final Optional<String> extensions) {
         PropertiesProviderTest pp = new PropertiesProviderTest();
-        pp.addProperty(XmlDirectoryStorageAdapter.DIRECTORY_STORAGE_PROP,file.getPath());
-        if(extensions.isPresent()) {
+        pp.addProperty(XmlDirectoryStorageAdapter.DIRECTORY_STORAGE_PROP, file.getPath());
+        if (extensions.isPresent()) {
             pp.addProperty(XmlDirectoryStorageAdapter.INCLUDE_EXT_PROP, extensions.get());
         }
 
@@ -42,7 +44,7 @@ public class DirectoryStorageAdapterTest {
         return dsa.instantiate(pp);
     }
 
-    private Persister instantiatePersisterFromAdapter(final File file){
+    private Persister instantiatePersisterFromAdapter(final File file) {
         return instantiatePersisterFromAdapter(file, Optional.<String>absent());
     }
 
@@ -68,13 +70,12 @@ public class DirectoryStorageAdapterTest {
             });
             fail();
         } catch (final UnsupportedOperationException e) {
-
+            // TODO: empty catch block
         }
     }
 
     private File getFolder(final String folderName) {
-        File result = new File(("src/test/resources/" +
-                folderName).replace("/", File.separator));
+        File result = new File(("src/test/resources/" + folderName).replace("/", File.separator));
         assertTrue(result + " is not a directory", result.isDirectory());
         return result;
     }
@@ -98,11 +99,13 @@ public class DirectoryStorageAdapterTest {
         LOG.info("Testing : {}", tested);
     }
 
-    private void assertResult(final ConfigSnapshotHolder result, final String s, final String... caps) throws SAXException, IOException {
-        assertXMLEqual(s, result.getConfigSnapshot());
-        int i = 0;
+    private void assertResult(final ConfigSnapshotHolder result,
+                              final String string,
+                              final String... caps) throws SAXException, IOException {
+        assertXMLEqual(string, result.getConfigSnapshot());
+        int index = 0;
         for (String capFromSnapshot : result.getCapabilities()) {
-            assertEquals(capFromSnapshot, caps[i++]);
+            assertEquals(capFromSnapshot, caps[index++]);
         }
     }