From 451ac09a6c84ea1e438ee1221470e629725379fc Mon Sep 17 00:00:00 2001 From: David Suarez Date: Tue, 12 Sep 2017 10:28:59 +0200 Subject: [PATCH] Fix checkstyle issues to enforce it Fix checkstyle issues to enforce it. Change-Id: Ic1c79114162d0c9772479e98df628d09daaa623b Signed-off-by: David Suarez --- .../pom.xml | 7 ++++++ .../directory/xml/XmlDirectoryPersister.java | 24 ++++++++++-------- .../xml/XmlDirectoryStorageAdapter.java | 11 ++++---- .../xml/DirectoryStorageAdapterTest.java | 25 +++++++++++-------- 4 files changed, 41 insertions(+), 26 deletions(-) diff --git a/opendaylight/config/config-persister-directory-xml-adapter/pom.xml b/opendaylight/config/config-persister-directory-xml-adapter/pom.xml index 1fb37450de..29c539a733 100644 --- a/opendaylight/config/config-persister-directory-xml-adapter/pom.xml +++ b/opendaylight/config/config-persister-directory-xml-adapter/pom.xml @@ -68,6 +68,13 @@ + + org.apache.maven.plugins + maven-checkstyle-plugin + + checkstyle.violationSeverity=error + + org.apache.felix maven-bundle-plugin diff --git a/opendaylight/config/config-persister-directory-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/directory/xml/XmlDirectoryPersister.java b/opendaylight/config/config-persister-directory-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/directory/xml/XmlDirectoryPersister.java index ae7954f76a..da4fbfbd23 100644 --- a/opendaylight/config/config-persister-directory-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/directory/xml/XmlDirectoryPersister.java +++ b/opendaylight/config/config-persister-directory-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/directory/xml/XmlDirectoryPersister.java @@ -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 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.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 fileExtensions) { this(storage, Optional.of(getFilter(fileExtensions))); @@ -66,7 +69,8 @@ public class XmlDirectoryPersister implements Persister { @Override public List 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 result = new ArrayList<>(); for (File file : sortedFiles) { LOG.trace("Adding file '{}' to combined result", file); - Optional h = fromXmlSnapshot(file); + Optional 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 SetfileExtensions) { - checkArgument(fileExtensions.isEmpty() == false, "No file extension provided", fileExtensions); + private static FilenameFilter getFilter(final Set 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 diff --git a/opendaylight/config/config-persister-directory-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/directory/xml/XmlDirectoryStorageAdapter.java b/opendaylight/config/config-persister-directory-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/directory/xml/XmlDirectoryStorageAdapter.java index 42ab93b585..576a24a41f 100644 --- a/opendaylight/config/config-persister-directory-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/directory/xml/XmlDirectoryStorageAdapter.java +++ b/opendaylight/config/config-persister-directory-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/directory/xml/XmlDirectoryStorageAdapter.java @@ -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)); } - } diff --git a/opendaylight/config/config-persister-directory-xml-adapter/src/test/java/org/opendaylight/controller/config/persist/storage/directory/xml/DirectoryStorageAdapterTest.java b/opendaylight/config/config-persister-directory-xml-adapter/src/test/java/org/opendaylight/controller/config/persist/storage/directory/xml/DirectoryStorageAdapterTest.java index 6aca047dec..1142e060aa 100644 --- a/opendaylight/config/config-persister-directory-xml-adapter/src/test/java/org/opendaylight/controller/config/persist/storage/directory/xml/DirectoryStorageAdapterTest.java +++ b/opendaylight/config/config-persister-directory-xml-adapter/src/test/java/org/opendaylight/controller/config/persist/storage/directory/xml/DirectoryStorageAdapterTest.java @@ -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 extensions){ + private Persister instantiatePersisterFromAdapter(final File file, final Optional 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.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++]); } } -- 2.36.6