From: Stephen Kitt Date: Fri, 12 May 2017 12:12:11 +0000 (+0200) Subject: config-persister-file-xml-adapter: final parameters X-Git-Tag: release/nitrogen~255 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=commitdiff_plain;h=de24c0e0c31714fb5a037d8dff72f4a285303b6a config-persister-file-xml-adapter: final parameters This automatically-generated patch flags all appropriate parameters as final (including caught exceptions). Change-Id: Ib4cdd95a3c54341995c1d40d9b9c45310f3153ab Signed-off-by: Stephen Kitt --- diff --git a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/XmlFileStorageAdapter.java b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/XmlFileStorageAdapter.java index c81aa9bec5..7ad0734159 100644 --- a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/XmlFileStorageAdapter.java +++ b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/XmlFileStorageAdapter.java @@ -51,7 +51,7 @@ public class XmlFileStorageAdapter implements StorageAdapter, Persister { } @Override - public Persister instantiate(PropertiesProvider propertiesProvider) { + public Persister instantiate(final PropertiesProvider propertiesProvider) { if(instance != null) { return instance; } @@ -71,7 +71,7 @@ public class XmlFileStorageAdapter implements StorageAdapter, Persister { if (!result) { throw new RuntimeException("Unable to create storage file " + localStorage); } - } catch (IOException e) { + } catch (final IOException e) { throw new RuntimeException("Unable to create storage file " + localStorage, e); } } @@ -98,16 +98,16 @@ public class XmlFileStorageAdapter implements StorageAdapter, Persister { } @VisibleForTesting - public void setFileStorage(File storage) { + public void setFileStorage(final File storage) { this.storage = storage; } @VisibleForTesting - public void setNumberOfBackups(Integer numberOfBackups) { + public void setNumberOfBackups(final Integer numberOfBackups) { numberOfStoredBackups = numberOfBackups; } - private static File extractStorageFileFromProperties(PropertiesProvider propertiesProvider) { + private static File extractStorageFileFromProperties(final PropertiesProvider propertiesProvider) { String fileStorageProperty = propertiesProvider.getProperty(FILE_STORAGE_PROP); Preconditions.checkNotNull(fileStorageProperty, "Unable to find " + propertiesProvider.getFullKeyForReporting(FILE_STORAGE_PROP)); File result = new File(fileStorageProperty); @@ -122,7 +122,7 @@ public class XmlFileStorageAdapter implements StorageAdapter, Persister { } @Override - public void persistConfig(ConfigSnapshotHolder holder) throws IOException { + public void persistConfig(final ConfigSnapshotHolder holder) throws IOException { Preconditions.checkNotNull(storage, "Storage file is null"); Set installedFeatureIds = Collections.emptySet(); diff --git a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/Config.java b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/Config.java index 63755f9e62..e043e45feb 100644 --- a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/Config.java +++ b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/Config.java @@ -33,7 +33,7 @@ public final class Config { private List snapshots; - Config(List snapshots) { + Config(final List snapshots) { this.snapshots = snapshots; } @@ -47,11 +47,11 @@ public final class Config { return snapshots; } - public void setSnapshots(List snapshots) { + public void setSnapshots(final List snapshots) { this.snapshots = snapshots; } - public void toXml(File to) { + public void toXml(final File to) { try { // TODO Moxy has to be used instead of default jaxb impl due to a bug @@ -63,12 +63,12 @@ public final class Config { marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); marshaller.marshal(this, to); - } catch (JAXBException e) { + } catch (final JAXBException e) { throw new PersistException("Unable to persist configuration", e); } } - public static Config fromXml(File from) { + public static Config fromXml(final File from) { if(isEmpty(from)) { return new Config(); } @@ -86,14 +86,14 @@ public final class Config { } } - private static boolean isEmpty(File from) { + private static boolean isEmpty(final File from) { return from.length() == 0 || isBlank(from); } - private static boolean isBlank(File from) { + private static boolean isBlank(final File from) { try { return StringUtils.isBlank(Files.toString(from, StandardCharsets.UTF_8)); - } catch (IOException e) { + } catch (final IOException e) { throw new IllegalStateException("Unexpected error reading file" + from, e); } } @@ -103,14 +103,14 @@ public final class Config { return last == null ? Optional.absent() : Optional.of(last); } - public void addConfigSnapshot(ConfigSnapshot snap, int numberOfStoredBackups) { + public void addConfigSnapshot(final ConfigSnapshot snap, final int numberOfStoredBackups) { if (shouldReplaceLast(numberOfStoredBackups) && !snapshots.isEmpty()) { snapshots.remove(0); } snapshots.add(snap); } - private boolean shouldReplaceLast(int numberOfStoredBackups) { + private boolean shouldReplaceLast(final int numberOfStoredBackups) { return numberOfStoredBackups == snapshots.size(); } } diff --git a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/ConfigSnapshot.java b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/ConfigSnapshot.java index 94cd58fc09..e84e75aa4d 100644 --- a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/ConfigSnapshot.java +++ b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/ConfigSnapshot.java @@ -27,12 +27,12 @@ public class ConfigSnapshot { private SortedSet capabilities = new TreeSet<>(); private Set features = new HashSet<>(); - ConfigSnapshot(String configXml, SortedSet capabilities) { + ConfigSnapshot(final String configXml, final SortedSet capabilities) { this.configXml = configXml; this.capabilities = capabilities; } - ConfigSnapshot(String configXml, SortedSet capabilities, Set features) { + ConfigSnapshot(final String configXml, final SortedSet capabilities, final Set features) { this.configXml = configXml; this.capabilities = capabilities; this.features = features; @@ -41,11 +41,11 @@ public class ConfigSnapshot { ConfigSnapshot() { } - public static ConfigSnapshot fromConfigSnapshot(ConfigSnapshotHolder cfg) { + public static ConfigSnapshot fromConfigSnapshot(final ConfigSnapshotHolder cfg) { return new ConfigSnapshot(cfg.getConfigSnapshot(), cfg.getCapabilities()); } - public static ConfigSnapshot fromConfigSnapshot(ConfigSnapshotHolder cfg, Set features) { + public static ConfigSnapshot fromConfigSnapshot(final ConfigSnapshotHolder cfg, final Set features) { return new ConfigSnapshot(cfg.getConfigSnapshot(), cfg.getCapabilities(), features); } @@ -54,7 +54,7 @@ public class ConfigSnapshot { return configXml; } - public void setConfigSnapshot(String configSnapshot) { + public void setConfigSnapshot(final String configSnapshot) { this.configXml = configSnapshot; } @@ -65,7 +65,7 @@ public class ConfigSnapshot { return capabilities; } - public void setCapabilities(SortedSet capabilities) { + public void setCapabilities(final SortedSet capabilities) { this.capabilities = capabilities; } diff --git a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/PersistException.java b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/PersistException.java index a0ccdb8e2e..0c7d22c1dd 100644 --- a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/PersistException.java +++ b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/PersistException.java @@ -10,7 +10,7 @@ package org.opendaylight.controller.config.persist.storage.file.xml.model; final class PersistException extends RuntimeException { private static final long serialVersionUID = 1L; - public PersistException(String s, Exception e) { + public PersistException(final String s, final Exception e) { super(s, e); } } diff --git a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/SnapshotHandler.java b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/SnapshotHandler.java index 2970367c71..e99694751b 100644 --- a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/SnapshotHandler.java +++ b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/SnapshotHandler.java @@ -24,13 +24,13 @@ class SnapshotHandler implements DomHandler { private StringWriter xmlWriter = new StringWriter(); @Override - public StreamResult createUnmarshaller(ValidationEventHandler errorHandler) { + public StreamResult createUnmarshaller(final ValidationEventHandler errorHandler) { xmlWriter.getBuffer().setLength(0); return new StreamResult(xmlWriter); } @Override - public String getElement(StreamResult rt) { + public String getElement(final StreamResult rt) { String xml = rt.getWriter().toString(); int beginIndex = xml.indexOf(START_TAG) + START_TAG.length(); int endIndex = xml.indexOf(END_TAG); @@ -40,12 +40,12 @@ class SnapshotHandler implements DomHandler { } @Override - public Source marshal(String n, ValidationEventHandler errorHandler) { + public Source marshal(final String n, final ValidationEventHandler errorHandler) { try { String xml = START_TAG + n.trim() + END_TAG; StringReader xmlReader = new StringReader(xml); return new StreamSource(xmlReader); - } catch(Exception e) { + } catch(final Exception e) { throw new RuntimeException(e); } } diff --git a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/StringTrimAdapter.java b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/StringTrimAdapter.java index 3c5f0bdab6..0308a726ab 100644 --- a/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/StringTrimAdapter.java +++ b/opendaylight/config/config-persister-file-xml-adapter/src/main/java/org/opendaylight/controller/config/persist/storage/file/xml/model/StringTrimAdapter.java @@ -11,7 +11,7 @@ import javax.xml.bind.annotation.adapters.XmlAdapter; final class StringTrimAdapter extends XmlAdapter { @Override - public String unmarshal(String v) throws Exception { + public String unmarshal(final String v) throws Exception { if (v == null) { return null; } @@ -19,7 +19,7 @@ final class StringTrimAdapter extends XmlAdapter { } @Override - public String marshal(String v) throws Exception { + public String marshal(final String v) throws Exception { if (v == null) { return null; }