August 2018 - tor-commits - lists.torproject.org

[metrics-lib/master] Remove redundant initializers.
by karsten＠torproject.org 27 Aug '18

27 Aug '18

commit 9cb9b78d945a78c90d12a3874c50f69bba7736b6 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Mon Aug 20 16:29:47 2018 +0200 Remove redundant initializers. --- .../java/org/torproject/descriptor/impl/DescriptorReaderImpl.java | 2 +- src/main/java/org/torproject/descriptor/impl/Key.java | 2 +- .../java/org/torproject/descriptor/impl/NetworkStatusEntryImpl.java | 2 +- src/main/java/org/torproject/descriptor/impl/NetworkStatusImpl.java | 2 +- src/main/java/org/torproject/descriptor/impl/ParseHelper.java | 2 +- src/main/java/org/torproject/descriptor/impl/TorperfResultImpl.java | 2 +- .../org/torproject/descriptor/index/DescriptorIndexCollector.java | 4 ++-- src/main/java/org/torproject/descriptor/internal/FileType.java | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java b/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java index a8a7790..8b0c64c 100644 --- a/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java @@ -178,7 +178,7 @@ public class DescriptorReaderImpl implements DescriptorReader { if (historyFile == null || !historyFile.exists()) { return; } - List<String> lines = null; + List<String> lines; try { lines = Files.readAllLines(historyFile.toPath(), StandardCharsets.UTF_8); diff --git a/src/main/java/org/torproject/descriptor/impl/Key.java b/src/main/java/org/torproject/descriptor/impl/Key.java index 763ecbf..602df09 100644 --- a/src/main/java/org/torproject/descriptor/impl/Key.java +++ b/src/main/java/org/torproject/descriptor/impl/Key.java @@ -163,7 +163,7 @@ public enum Key { /** Retrieve a Key for a keyword. * Returns Key.INVALID for non-existing keywords. */ public static Key get(String keyword) { - Key res = INVALID; + Key res; try { res = keywordMap.get(keyword); } catch (Throwable th) { diff --git a/src/main/java/org/torproject/descriptor/impl/NetworkStatusEntryImpl.java b/src/main/java/org/torproject/descriptor/impl/NetworkStatusEntryImpl.java index 3c0c1af..9ebedbd 100644 --- a/src/main/java/org/torproject/descriptor/impl/NetworkStatusEntryImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/NetworkStatusEntryImpl.java @@ -77,7 +77,7 @@ public class NetworkStatusEntryImpl implements NetworkStatusEntry { * this.parent.length as bounds, which is not what we want! */ Scanner scanner = this.parent.newScanner(this.offset, this.length) .useDelimiter(NL); - String line = null; + String line; if (!scanner.hasNext() || !(line = scanner.next()).startsWith("r ")) { throw new DescriptorParseException("Status entry must start with " + "an r line."); diff --git a/src/main/java/org/torproject/descriptor/impl/NetworkStatusImpl.java b/src/main/java/org/torproject/descriptor/impl/NetworkStatusImpl.java index 60a9ff3..0694aff 100644 --- a/src/main/java/org/torproject/descriptor/impl/NetworkStatusImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/NetworkStatusImpl.java @@ -116,7 +116,7 @@ public abstract class NetworkStatusImpl extends DescriptorImpl { protected String[] parseClientOrServerVersions(String line, String[] parts) throws DescriptorParseException { - String[] result = null; + String[] result; switch (parts.length) { case 1: result = new String[0]; diff --git a/src/main/java/org/torproject/descriptor/impl/ParseHelper.java b/src/main/java/org/torproject/descriptor/impl/ParseHelper.java index 93ad610..1bba92e 100644 --- a/src/main/java/org/torproject/descriptor/impl/ParseHelper.java +++ b/src/main/java/org/torproject/descriptor/impl/ParseHelper.java @@ -77,7 +77,7 @@ public class ParseHelper { protected static int parsePort(String line, String portString) throws DescriptorParseException { - int port = -1; + int port; try { port = Integer.parseInt(portString); } catch (NumberFormatException e) { diff --git a/src/main/java/org/torproject/descriptor/impl/TorperfResultImpl.java b/src/main/java/org/torproject/descriptor/impl/TorperfResultImpl.java index 5a8ec66..47de53f 100644 --- a/src/main/java/org/torproject/descriptor/impl/TorperfResultImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/TorperfResultImpl.java @@ -300,7 +300,7 @@ public class TorperfResultImpl extends DescriptorImpl String line) throws DescriptorParseException { String key = keyValue.substring(0, keyValue.indexOf("=")); String percentileString = key.substring("DATAPERC".length()); - int percentile = -1; + int percentile; try { percentile = Integer.parseInt(percentileString); } catch (NumberFormatException e) { diff --git a/src/main/java/org/torproject/descriptor/index/DescriptorIndexCollector.java b/src/main/java/org/torproject/descriptor/index/DescriptorIndexCollector.java index 48bb40c..774708f 100644 --- a/src/main/java/org/torproject/descriptor/index/DescriptorIndexCollector.java +++ b/src/main/java/org/torproject/descriptor/index/DescriptorIndexCollector.java @@ -62,8 +62,8 @@ public class DescriptorIndexCollector implements DescriptorCollector { } log.info("Indexing local directory {}.", localDirectory.getAbsolutePath()); SortedMap<String, Long> localFiles = statLocalDirectory(localDirectory); - SortedMap<String, FileNode> remoteFiles = null; - IndexNode index = null; + SortedMap<String, FileNode> remoteFiles; + IndexNode index; String indexUrlString = ""; try { URL indexUrl = new URL(collecTorIndexUrlString); diff --git a/src/main/java/org/torproject/descriptor/internal/FileType.java b/src/main/java/org/torproject/descriptor/internal/FileType.java index 2c07df6..95acf2f 100644 --- a/src/main/java/org/torproject/descriptor/internal/FileType.java +++ b/src/main/java/org/torproject/descriptor/internal/FileType.java @@ -49,7 +49,7 @@ public enum FileType { * @since 2.1.0 */ public static FileType findType(String ext) { - FileType res = null; + FileType res; try { res = FileType.valueOf(ext.toUpperCase()); return res;

1 0

[metrics-lib/master] Avoid string concatenation in a loop.
by karsten＠torproject.org 27 Aug '18

27 Aug '18

commit 273f3c2e13bbf7021b0758ddc52c0e8be071dd4c Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Mon Aug 20 20:27:24 2018 +0200 Avoid string concatenation in a loop. --- src/main/java/org/torproject/descriptor/index/IndexNode.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/torproject/descriptor/index/IndexNode.java b/src/main/java/org/torproject/descriptor/index/IndexNode.java index 02b5972..6852681 100644 --- a/src/main/java/org/torproject/descriptor/index/IndexNode.java +++ b/src/main/java/org/torproject/descriptor/index/IndexNode.java @@ -137,13 +137,13 @@ public class IndexNode { if (null == currentDir) { continue; } - String currentPath = dirs[0] + "/"; + StringBuilder currentPath = new StringBuilder(dirs[0] + "/"); for (int k = 1; k < dirs.length; k++) { DirectoryNode dn = findPathIn(dirs[k], currentDir.directories); if (null == dn) { break; } else { - currentPath += dirs[k] + "/"; + currentPath.append(dirs[k]).append("/"); currentDir = dn; } } @@ -152,7 +152,7 @@ public class IndexNode { } for (FileNode file : currentDir.files) { if (file.lastModifiedMillis() > 0) { // only add valid files - map.put(currentPath + file.path, file); + map.put(currentPath.toString() + file.path, file); } } }

1 0

[metrics-lib/master] Access static method via class.
by karsten＠torproject.org 27 Aug '18

27 Aug '18

commit 5ec75a50c87e364920c9547fd2f81f63283d32ca Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Mon Aug 20 19:53:00 2018 +0200 Access static method via class. --- .../org/torproject/descriptor/index/DescriptorIndexCollectorTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/test/java/org/torproject/descriptor/index/DescriptorIndexCollectorTest.java b/src/test/java/org/torproject/descriptor/index/DescriptorIndexCollectorTest.java index 6e4978b..2ac3359 100644 --- a/src/test/java/org/torproject/descriptor/index/DescriptorIndexCollectorTest.java +++ b/src/test/java/org/torproject/descriptor/index/DescriptorIndexCollectorTest.java @@ -131,7 +131,7 @@ public class DescriptorIndexCollectorTest { IndexNode in = new IndexNode("2016-01-01 01:01", remoteDirectory, null, dm); File indexFile = tmpf.newFile(name); - in.writeIndex(indexFile.toPath(), in); + IndexNode.writeIndex(indexFile.toPath(), in); return indexFile; }

1 0

[metrics-lib/master] Delete methods that only call their super.
by karsten＠torproject.org 27 Aug '18

27 Aug '18

commit 014917d377662c3cf3bb345a0435797e98115c1d Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Mon Aug 20 20:16:31 2018 +0200 Delete methods that only call their super. --- .../org/torproject/descriptor/impl/ParseHelper.java | 19 +------------------ 1 file changed, 1 insertion(+), 18 deletions(-) diff --git a/src/main/java/org/torproject/descriptor/impl/ParseHelper.java b/src/main/java/org/torproject/descriptor/impl/ParseHelper.java index 1bba92e..f196b2f 100644 --- a/src/main/java/org/torproject/descriptor/impl/ParseHelper.java +++ b/src/main/java/org/torproject/descriptor/impl/ParseHelper.java @@ -154,24 +154,7 @@ public class ParseHelper { } private static ThreadLocal<Map<String, DateFormat>> dateFormats = - new ThreadLocal<Map<String, DateFormat>>() { - - public Map<String, DateFormat> get() { - return super.get(); - } - - protected Map<String, DateFormat> initialValue() { - return new HashMap<>(); - } - - public void remove() { - super.remove(); - } - - public void set(Map<String, DateFormat> value) { - super.set(value); - } - }; + ThreadLocal.withInitial(HashMap::new); static DateFormat getDateFormat(String format) { Map<String, DateFormat> threadDateFormats = dateFormats.get();

1 0

[metrics-lib/master] Remove unused attribute.
by karsten＠torproject.org 27 Aug '18

27 Aug '18

commit ccd8bbaedfb619d07fabcb2aee4cf4ab51f7a9a1 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Mon Aug 20 19:57:06 2018 +0200 Remove unused attribute. --- .../java/org/torproject/descriptor/impl/DescriptorReaderImpl.java | 7 ------- 1 file changed, 7 deletions(-) diff --git a/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java b/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java index 8b0c64c..5ce99e1 100644 --- a/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java @@ -125,8 +125,6 @@ public class DescriptorReaderImpl implements DescriptorReader { private BlockingIteratorImpl<Descriptor> descriptorQueue; - private File autoSaveHistoryFile; - private File manualSaveHistoryFile; private List<File> tarballs = new ArrayList<>(); @@ -146,7 +144,6 @@ public class DescriptorReaderImpl implements DescriptorReader { File manualSaveHistoryFile, SortedMap<String, Long> excludedFiles) { this.descriptorFiles = descriptorFiles; this.descriptorQueue = descriptorQueue; - this.autoSaveHistoryFile = autoSaveHistoryFile; this.manualSaveHistoryFile = manualSaveHistoryFile; if (excludedFiles != null) { this.excludedFilesBefore = excludedFiles; @@ -156,7 +153,6 @@ public class DescriptorReaderImpl implements DescriptorReader { public void run() { try { - this.readOldHistory(this.autoSaveHistoryFile); this.readOldHistory(this.manualSaveHistoryFile); this.readDescriptorFiles(); this.readTarballs(); @@ -169,9 +165,6 @@ public class DescriptorReaderImpl implements DescriptorReader { this.descriptorQueue.setOutOfDescriptors(); } } - if (this.hasFinishedReading) { - this.writeNewHistory(this.autoSaveHistoryFile); - } } private void readOldHistory(File historyFile) {

1 0

[metrics-lib/master] Use diamond operator in a few more places.
by karsten＠torproject.org 27 Aug '18

27 Aug '18

commit 7fcc7e79c8cc4ce007030cdd9cddf5c559d0784b Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Tue Aug 21 09:43:48 2018 +0200 Use diamond operator in a few more places. --- src/main/java/org/torproject/descriptor/index/IndexNode.java | 2 +- .../java/org/torproject/descriptor/index/DirectoryNodeTest.java | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/torproject/descriptor/index/IndexNode.java b/src/main/java/org/torproject/descriptor/index/IndexNode.java index 6852681..b6855e3 100644 --- a/src/main/java/org/torproject/descriptor/index/IndexNode.java +++ b/src/main/java/org/torproject/descriptor/index/IndexNode.java @@ -48,7 +48,7 @@ public class IndexNode { /** An empty node, which is not added to JSON output. */ public static final IndexNode emptyNode = new IndexNode("", "", - new TreeSet<FileNode>(), new TreeSet<DirectoryNode>()); + new TreeSet<>(), new TreeSet<>()); private static ObjectMapper objectMapper = new ObjectMapper() .setPropertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE) diff --git a/src/test/java/org/torproject/descriptor/index/DirectoryNodeTest.java b/src/test/java/org/torproject/descriptor/index/DirectoryNodeTest.java index fc545f6..eff1edf 100644 --- a/src/test/java/org/torproject/descriptor/index/DirectoryNodeTest.java +++ b/src/test/java/org/torproject/descriptor/index/DirectoryNodeTest.java @@ -17,10 +17,10 @@ public class DirectoryNodeTest { public void testCompare() { DirectoryNode dn1 = new DirectoryNode("a1", null, null); DirectoryNode dn2 = new DirectoryNode("a2", null, - new TreeSet<DirectoryNode>()); + new TreeSet<>()); assertEquals(-1, dn1.compareTo(dn2)); - DirectoryNode dn3 = new DirectoryNode("a1", new TreeSet<FileNode>(), - new TreeSet<DirectoryNode>()); + DirectoryNode dn3 = new DirectoryNode("a1", new TreeSet<>(), + new TreeSet<>()); assertEquals(0, dn1.compareTo(dn3)); assertEquals(1, dn2.compareTo(dn3)); }

1 0

[metrics-lib/master] Remove redundant escape in regular expressions.
by karsten＠torproject.org 27 Aug '18

27 Aug '18

commit 18c5864591410eddf30a594fa7508cc7edb26ef4 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Mon Aug 20 20:51:19 2018 +0200 Remove redundant escape in regular expressions. Turns out that characters inside square brackets don't need to be escaped. In fact, "^[0-9\\.]{7,15}$" does not only match valid IPv4 addresses but also strings like "1\2\3\4". --- src/main/java/org/torproject/descriptor/impl/ParseHelper.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/torproject/descriptor/impl/ParseHelper.java b/src/main/java/org/torproject/descriptor/impl/ParseHelper.java index f196b2f..514bea8 100644 --- a/src/main/java/org/torproject/descriptor/impl/ParseHelper.java +++ b/src/main/java/org/torproject/descriptor/impl/ParseHelper.java @@ -44,7 +44,7 @@ public class ParseHelper { return keyword; } - private static Pattern ipv4Pattern = Pattern.compile("^[0-9\\.]{7,15}$"); + private static Pattern ipv4Pattern = Pattern.compile("^[0-9.]{7,15}$"); protected static String parseIpv4Address(String line, String address) throws DescriptorParseException {

1 0

[metrics-lib/master] Remove unnecessary modifiers and semicolons.
by karsten＠torproject.org 27 Aug '18

27 Aug '18

commit f82e5e587817cf631e6cfcacb687cc49ea196931 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Tue Aug 21 09:23:25 2018 +0200 Remove unnecessary modifiers and semicolons. --- src/main/java/org/torproject/descriptor/Method.java | 2 +- src/main/java/org/torproject/descriptor/impl/Key.java | 2 +- .../org/torproject/descriptor/impl/RelayDirectoryImpl.java | 2 +- .../torproject/descriptor/log/InternalLogDescriptor.java | 14 +++++++------- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/main/java/org/torproject/descriptor/Method.java b/src/main/java/org/torproject/descriptor/Method.java index 9135fe2..771fb10 100644 --- a/src/main/java/org/torproject/descriptor/Method.java +++ b/src/main/java/org/torproject/descriptor/Method.java @@ -5,5 +5,5 @@ package org.torproject.descriptor; /** Enum for web server access log methods. */ public enum Method { - GET, HEAD, POST; + GET, HEAD, POST } diff --git a/src/main/java/org/torproject/descriptor/impl/Key.java b/src/main/java/org/torproject/descriptor/impl/Key.java index 602df09..f7b613f 100644 --- a/src/main/java/org/torproject/descriptor/impl/Key.java +++ b/src/main/java/org/torproject/descriptor/impl/Key.java @@ -156,7 +156,7 @@ public enum Key { keywordMap.remove(EMPTY.keyword); } - private Key(String keyword) { + Key(String keyword) { this.keyword = keyword; } diff --git a/src/main/java/org/torproject/descriptor/impl/RelayDirectoryImpl.java b/src/main/java/org/torproject/descriptor/impl/RelayDirectoryImpl.java index d87b962..5eb5b6f 100644 --- a/src/main/java/org/torproject/descriptor/impl/RelayDirectoryImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/RelayDirectoryImpl.java @@ -357,7 +357,7 @@ public class RelayDirectoryImpl extends DescriptorImpl } else { isLive = true; fingerprint = ParseHelper.parseTwentyByteHexString( - debugLine, part.substring(1));; + debugLine, part.substring(1)); } entry = new RouterStatusEntryImpl(fingerprint, nickname, isLive, isVerified); diff --git a/src/main/java/org/torproject/descriptor/log/InternalLogDescriptor.java b/src/main/java/org/torproject/descriptor/log/InternalLogDescriptor.java index 3c0039b..f77536e 100644 --- a/src/main/java/org/torproject/descriptor/log/InternalLogDescriptor.java +++ b/src/main/java/org/torproject/descriptor/log/InternalLogDescriptor.java @@ -14,14 +14,14 @@ import org.torproject.descriptor.LogDescriptor; public interface InternalLogDescriptor extends LogDescriptor { /** Logfile name parts separator. */ - public static final String SEP = "_"; + String SEP = "_"; /** * Validate log lines. * * @since 2.2.0 */ - public void validate() throws DescriptorParseException; + void validate() throws DescriptorParseException; /** * Set the <code>Validator</code> that will perform the validation on log @@ -31,31 +31,31 @@ public interface InternalLogDescriptor extends LogDescriptor { * * @since 2.2.0 */ - public void setValidator(Validator validator); + void setValidator(Validator validator); /** * Set the descriptor's bytes. * * @since 2.2.0 */ - public void setRawDescriptorBytes(byte[] bytes); + void setRawDescriptorBytes(byte[] bytes); /** Return the descriptor's preferred compression. */ - public String getCompressionType(); + String getCompressionType(); /** * Provides a single function for validating a single log line. * * @since 2.2.0 */ - public interface Validator { + interface Validator { /** * Verifies a log line. * * @since 2.2.0 */ - public boolean validate(String line); + boolean validate(String line); }

1 0

[metrics-lib/master] Make a couple JavaDoc fixes.
by karsten＠torproject.org 27 Aug '18

27 Aug '18

commit 8b4dacfbc061499de0eff2ba7706478574db1fd4 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Tue Aug 21 09:52:26 2018 +0200 Make a couple JavaDoc fixes. --- .../descriptor/DescriptorSourceFactory.java | 4 ++-- .../torproject/descriptor/ExtraInfoDescriptor.java | 2 +- .../org/torproject/descriptor/LogDescriptor.java | 4 ++-- .../descriptor/RelayNetworkStatusConsensus.java | 4 ++-- .../descriptor/RelayNetworkStatusVote.java | 4 ++-- .../org/torproject/descriptor/TorperfResult.java | 26 +++++++++++----------- .../torproject/descriptor/impl/DescriptorImpl.java | 14 ++++++------ .../descriptor/index/DescriptorIndexCollector.java | 6 ++--- .../torproject/descriptor/internal/FileType.java | 2 +- .../descriptor/log/InternalLogDescriptor.java | 2 +- 10 files changed, 34 insertions(+), 34 deletions(-) diff --git a/src/main/java/org/torproject/descriptor/DescriptorSourceFactory.java b/src/main/java/org/torproject/descriptor/DescriptorSourceFactory.java index 495968c..e755e42 100644 --- a/src/main/java/org/torproject/descriptor/DescriptorSourceFactory.java +++ b/src/main/java/org/torproject/descriptor/DescriptorSourceFactory.java @@ -31,10 +31,10 @@ import org.slf4j.LoggerFactory; * the following is an example for using a different implementation of the * descriptor downloader: * - * <code> + * {@code * java -Ddescriptor.downloader=my.special.descriptorimpl.Downloader \ * my.app.Mainclass - * </code> + * } * * @since 1.0.0 */ diff --git a/src/main/java/org/torproject/descriptor/ExtraInfoDescriptor.java b/src/main/java/org/torproject/descriptor/ExtraInfoDescriptor.java index 1ffb418..812d6aa 100644 --- a/src/main/java/org/torproject/descriptor/ExtraInfoDescriptor.java +++ b/src/main/java/org/torproject/descriptor/ExtraInfoDescriptor.java @@ -619,7 +619,7 @@ public interface ExtraInfoDescriptor extends Descriptor { long getPaddingCountsStatsIntervalLength(); /** - * Return padding-counts statistics, or <code>null</code> if no such + * Return padding-counts statistics, or {@code null} if no such * statistics are included. * * @since 1.7.0 diff --git a/src/main/java/org/torproject/descriptor/LogDescriptor.java b/src/main/java/org/torproject/descriptor/LogDescriptor.java index a8448f6..5828441 100644 --- a/src/main/java/org/torproject/descriptor/LogDescriptor.java +++ b/src/main/java/org/torproject/descriptor/LogDescriptor.java @@ -13,7 +13,8 @@ import java.util.stream.Stream; * Unlike other descriptors, logs can get very large and are typically stored * on disk in compressed form. Access to log contents through this * interface and its subinterfaces is made available in compressed and - * decompressed form: + * decompressed form: + * * <ul> * <li>The raw descriptor bytes are compressed, because logs contain * often redundant information that can achieve high compression rates. @@ -21,7 +22,6 @@ import java.util.stream.Stream; * <li>The uncompressed log contents can be accessed as a stream of bytes.</li> * <li>A list of log lines (decompressed) can be retrieved.</li> * </ul> - * * * @since 2.2.0 */ diff --git a/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java b/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java index e03f40b..e8ec89f 100644 --- a/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java +++ b/src/main/java/org/torproject/descriptor/RelayNetworkStatusConsensus.java @@ -150,8 +150,8 @@ public interface RelayNetworkStatusConsensus extends Descriptor { /** * Return a list of software packages and their versions together with a - * URL and one or more digests in the format <code>PackageName Version - * URL DIGESTS</code> that are known by at least three directory + * URL and one or more digests in the format {@code PackageName Version + * URL DIGESTS} that are known by at least three directory * authorities and agreed upon by the majority of directory authorities, * or null if the consensus does not contain package information. * diff --git a/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java b/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java index a507d8c..9514765 100644 --- a/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java +++ b/src/main/java/org/torproject/descriptor/RelayNetworkStatusVote.java @@ -138,8 +138,8 @@ public interface RelayNetworkStatusVote extends Descriptor { /** * Return a list of software packages and their versions together with a - * URL and one or more digests in the format <code>PackageName Version - * URL DIGESTS</code> that are known by this directory authority, or + * URL and one or more digests in the format {@code PackageName Version + * URL DIGESTS} that are known by this directory authority, or * null if this descriptor does not contain package information. * * @since 1.3.0 diff --git a/src/main/java/org/torproject/descriptor/TorperfResult.java b/src/main/java/org/torproject/descriptor/TorperfResult.java index c92ae78..add36ff 100644 --- a/src/main/java/org/torproject/descriptor/TorperfResult.java +++ b/src/main/java/org/torproject/descriptor/TorperfResult.java @@ -215,8 +215,8 @@ public interface TorperfResult extends Descriptor { /** * Return the hostname, IP address, and port that the TGen client used to * connect to the local tor SOCKS port, formatted as - * <code>hostname:ip:port</code>, which may be <code>"NULL:0.0.0.0:0"</code> - * if TGen was not able to find this information or <code>null</code> if the + * {@code hostname:ip:port}, which may be {@code "NULL:0.0.0.0:0"} + * if TGen was not able to find this information or {@code null} if the * OnionPerf line didn't contain this information. * * @since 1.7.0 @@ -226,8 +226,8 @@ public interface TorperfResult extends Descriptor { /** * Return the hostname, IP address, and port that the TGen client used to * connect to the SOCKS proxy server that tor runs, formatted as - * <code>hostname:ip:port</code>, which may be <code>"NULL:0.0.0.0:0"</code> - * if TGen was not able to find this information or <code>null</code> if the + * {@code hostname:ip:port}, which may be {@code "NULL:0.0.0.0:0"} + * if TGen was not able to find this information or {@code null} if the * OnionPerf line didn't contain this information. * * @since 1.7.0 @@ -236,9 +236,9 @@ public interface TorperfResult extends Descriptor { /** * Return the hostname, IP address, and port that the TGen client used to - * connect to the remote server, formatted as <code>hostname:ip:port</code>, - * which may be <code>"NULL:0.0.0.0:0"</code> if TGen was not able to find - * this information or <code>null</code> if the OnionPerf line didn't contain + * connect to the remote server, formatted as {@code hostname:ip:port}, + * which may be {@code "NULL:0.0.0.0:0"} if TGen was not able to find + * this information or {@code null} if the OnionPerf line didn't contain * this information. * * @since 1.7.0 @@ -246,8 +246,8 @@ public interface TorperfResult extends Descriptor { String getEndpointRemote(); /** - * Return the client machine hostname, which may be <code>"(NULL)"</code> if - * the TGen client was not able to find this information or <code>null</code> + * Return the client machine hostname, which may be {@code "(NULL)"} if + * the TGen client was not able to find this information or {@code null} * if the OnionPerf line didn't contain this information. * * @since 1.7.0 @@ -255,8 +255,8 @@ public interface TorperfResult extends Descriptor { String getHostnameLocal(); /** - * Return the server machine hostname, which may be <code>"(NULL)"</code> if - * the TGen server was not able to find this information or <code>null</code> + * Return the server machine hostname, which may be {@code "(NULL)"} if + * the TGen server was not able to find this information or {@code null} * if the OnionPerf line didn't contain this information. * * @since 1.7.0 @@ -266,8 +266,8 @@ public interface TorperfResult extends Descriptor { /** * Return the public IP address of the OnionPerf host obtained by connecting * to well-known servers and finding the IP address in the result, which may - * be <code>"unknown"</code> if OnionPerf was not able to find this - * information or <code>null</code> if the OnionPerf line didn't contain this + * be {@code "unknown"} if OnionPerf was not able to find this + * information or {@code null} if the OnionPerf line didn't contain this * information. * * @since 1.7.0 diff --git a/src/main/java/org/torproject/descriptor/impl/DescriptorImpl.java b/src/main/java/org/torproject/descriptor/impl/DescriptorImpl.java index 70fe7c6..1ae85d6 100644 --- a/src/main/java/org/torproject/descriptor/impl/DescriptorImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/DescriptorImpl.java @@ -60,7 +60,7 @@ public abstract class DescriptorImpl implements Descriptor { } /** - * Returns a <emph>copy</emph> of the full raw descriptor bytes. + * Returns a copy of the full raw descriptor bytes. * * If possible, subclasses should avoid retrieving raw descriptor bytes and * converting them to a String themselves and instead rely on @@ -74,8 +74,8 @@ public abstract class DescriptorImpl implements Descriptor { } /** - * Returns a <emph>copy</emph> of raw descriptor bytes starting at - * <code>offset</code> and containing <code>length</code> bytes. + * Returns a copy of raw descriptor bytes starting at + * {@code offset} and containing {@code length} bytes. * * If possible, subclasses should avoid retrieving raw descriptor bytes and * converting them to a String themselves and instead rely on @@ -109,7 +109,7 @@ public abstract class DescriptorImpl implements Descriptor { /** * Returns a new {@link Scanner} for parsing the raw descriptor starting at - * byte <code>offset</code> containing <code>length</code> bytes using UTF-8 + * byte {@code offset} containing {@code length} bytes using UTF-8 * as charset. * * @param offset The index of the first byte to parse. @@ -123,7 +123,7 @@ public abstract class DescriptorImpl implements Descriptor { /** * Returns the index within the raw descriptor of the first occurrence of the - * given <code>key</code>, or <code>-1</code> if the key is not contained. + * given {@code key}, or {@code -1} if the key is not contained. * * @param key Key to search for. * @return Index of the first occurrence, or -1. @@ -148,8 +148,8 @@ public abstract class DescriptorImpl implements Descriptor { /** * Returns a list of two-element arrays containing offsets and lengths of - * descriptors starting with the given <code>key</code> in the raw descriptor - * starting at byte <code>offset</code> containing <code>length</code> bytes. + * descriptors starting with the given {@code key} in the raw descriptor + * starting at byte {@code offset} containing {@code length} bytes. * * @param key Key to search for. * @param offset The index of the first byte to split. diff --git a/src/main/java/org/torproject/descriptor/index/DescriptorIndexCollector.java b/src/main/java/org/torproject/descriptor/index/DescriptorIndexCollector.java index 774708f..9e053dc 100644 --- a/src/main/java/org/torproject/descriptor/index/DescriptorIndexCollector.java +++ b/src/main/java/org/torproject/descriptor/index/DescriptorIndexCollector.java @@ -34,11 +34,11 @@ public class DescriptorIndexCollector implements DescriptorCollector { .getLogger(DescriptorIndexCollector.class); /** - * If <code>collecTorIndexUrlString</code> contains just the + * If {@code collecTorIndexUrlString} contains just the * base url, e.g. https://some.host.org, the path - * <code>/index/index.json</code> will be appended. + * {@code /index/index.json} will be appended. * If a path is given (even just a final slash, e.g. https://some.host.org/) - * the <code>collecTorIndexUrlString</code> will be used as is. + * the {@code collecTorIndexUrlString} will be used as is. */ @Override public void collectDescriptors(String collecTorIndexUrlString, diff --git a/src/main/java/org/torproject/descriptor/internal/FileType.java b/src/main/java/org/torproject/descriptor/internal/FileType.java index 95acf2f..8f42624 100644 --- a/src/main/java/org/torproject/descriptor/internal/FileType.java +++ b/src/main/java/org/torproject/descriptor/internal/FileType.java @@ -43,7 +43,7 @@ public enum FileType { } /** - * Returns <code>valueOf</code> or the default enum {@link #PLAIN}, i.e., + * Returns {@code valueOf} or the default enum {@link #PLAIN}, i.e., * this method doesn't throw any exceptions and allways returns a valid enum. * * @since 2.1.0 diff --git a/src/main/java/org/torproject/descriptor/log/InternalLogDescriptor.java b/src/main/java/org/torproject/descriptor/log/InternalLogDescriptor.java index f77536e..558f02a 100644 --- a/src/main/java/org/torproject/descriptor/log/InternalLogDescriptor.java +++ b/src/main/java/org/torproject/descriptor/log/InternalLogDescriptor.java @@ -24,7 +24,7 @@ public interface InternalLogDescriptor extends LogDescriptor { void validate() throws DescriptorParseException; /** - * Set the <code>Validator</code> that will perform the validation on log + * Set the {@code Validator} that will perform the validation on log * lines. * * Usually set by the implementing class.

1 0

[metrics-lib/master] Use parameterized log statements.
by karsten＠torproject.org 27 Aug '18

27 Aug '18

commit 53857805b626184461c572559ecbab42fc74ee1a Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Tue Aug 21 10:22:58 2018 +0200 Use parameterized log statements. --- .../java/org/torproject/descriptor/impl/DescriptorReaderImpl.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java b/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java index 5ce99e1..46d17ef 100644 --- a/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java +++ b/src/main/java/org/torproject/descriptor/impl/DescriptorReaderImpl.java @@ -158,8 +158,8 @@ public class DescriptorReaderImpl implements DescriptorReader { this.readTarballs(); this.hasFinishedReading = true; } catch (Throwable t) { - log.error("Bug: uncaught exception or error while " - + "reading descriptors: " + t.getMessage(), t); + log.error("Bug: uncaught exception or error while reading descriptors.", + t); } finally { if (null != this.descriptorQueue) { this.descriptorQueue.setOutOfDescriptors();

1 0