From bc0b8fa1ef9714943152c896535c1facefc2d3af Mon Sep 17 00:00:00 2001 From: Daniel Oeh Date: Mon, 28 May 2012 00:58:40 +0200 Subject: [PATCH] Applied some checkstyle-rules --- src/de/podfetcher/util/Converter.java | 42 ++++++++++++++++----- src/de/podfetcher/util/NumberGenerator.java | 16 ++++++-- src/de/podfetcher/util/URLChecker.java | 30 ++++++++++----- 3 files changed, 65 insertions(+), 23 deletions(-) diff --git a/src/de/podfetcher/util/Converter.java b/src/de/podfetcher/util/Converter.java index fcf91015b..262debe51 100644 --- a/src/de/podfetcher/util/Converter.java +++ b/src/de/podfetcher/util/Converter.java @@ -2,29 +2,51 @@ package de.podfetcher.util; import android.util.Log; -/** Provides methods for converting various units */ -public class Converter { +/** Provides methods for converting various units. */ +public final class Converter { + /** Class shall not be instantiated. */ + private Converter() { + } + + /** Logging tag. */ private static final String TAG = "Converter"; - public static String byteToString(long input) { + + /** Indicates that the value is in the Byte range.*/ + private static final int B_RANGE = 0; + /** Indicates that the value is in the Kilobyte range.*/ + private static final int KB_RANGE = 1; + /** Indicates that the value is in the Megabyte range.*/ + private static final int MB_RANGE = 2; + /** Indicates that the value is in the Gigabyte range.*/ + private static final int GB_RANGE = 3; + /** Determines the length of the number for best readability.*/ + private static final int NUM_LENGTH = 1000; + + /** Takes a byte-value and converts it into a more readable + * String. + * @param input The value to convert + * @return The converted String with a unit + * */ + public static String byteToString(final long input) { int i = 0; int result = 0; - for(i = 0; i < 4; i++) { + for (i = 0; i < GB_RANGE + 1; i++) { result = (int) (input / Math.pow(1024, i)); - if(result < 1000) { + if (result < NUM_LENGTH) { break; } } - switch(i) { - case 0: + switch (i) { + case B_RANGE: return result + " B"; - case 1: + case KB_RANGE: return result + " KB"; - case 2: + case MB_RANGE: return result + " MB"; - case 3: + case GB_RANGE: return result + " GB"; default: Log.e(TAG, "Error happened in byteToString"); diff --git a/src/de/podfetcher/util/NumberGenerator.java b/src/de/podfetcher/util/NumberGenerator.java index 81220820a..2ffefbbaa 100644 --- a/src/de/podfetcher/util/NumberGenerator.java +++ b/src/de/podfetcher/util/NumberGenerator.java @@ -3,11 +3,21 @@ package de.podfetcher.util; import java.util.Random; import android.util.Log; -/** Utility class for creating large random numbers */ -public class NumberGenerator { +/**Utility class for creating large random numbers.*/ +public final class NumberGenerator { + /** Class shall not be instantiated.*/ + private NumberGenerator() { + } + + /**Logging tag.*/ private static final String TAG = "NumberGenerator"; - public static long generateLong(String strSeed) { + /** Takes a string and generates a random value out of + * the hash-value of that string. + * @param strSeed The string to take for the return value + * @return The generated random value + * */ + public static long generateLong(final String strSeed) { long seed = (long) strSeed.hashCode(); Log.d(TAG, "Taking " + seed + " as seed."); return new Random(seed).nextLong(); diff --git a/src/de/podfetcher/util/URLChecker.java b/src/de/podfetcher/util/URLChecker.java index e8916f06a..f862b03a9 100644 --- a/src/de/podfetcher/util/URLChecker.java +++ b/src/de/podfetcher/util/URLChecker.java @@ -1,29 +1,39 @@ package de.podfetcher.util; -import android.webkit.URLUtil; import android.util.Log; -/** Provides methods for checking and editing a URL */ -public class URLChecker { +/** Provides methods for checking and editing a URL.*/ +public final class URLChecker { - private static final String TAG = "URLChecker"; + /**Class shall not be instantiated.*/ + private URLChecker() { + } + + /**Logging tag.*/ + private static final String TAG = "URLChecker"; + /**Indicator for URLs made by Feedburner.*/ private static final String FEEDBURNER_URL = "feeds.feedburner.com"; + /**Prefix that is appended to URLs by Feedburner.*/ private static final String FEEDBURNER_PREFIX = "?format=xml"; - /** Checks if URL is valid and modifies it if necessary */ - public static String prepareURL(String url) { + /** Checks if URL is valid and modifies it if necessary. + * @param url The url which is going to be prepared + * @return The prepared url + * */ + public static String prepareURL(final String url) { StringBuilder builder = new StringBuilder(); - if(!url.startsWith("http")) { + if (!url.startsWith("http")) { builder.append("http://"); Log.d(TAG, "Missing http; appending"); } builder.append(url); - if(url.contains(FEEDBURNER_URL)) { - Log.d(TAG, "URL seems to be Feedburner URL; appending prefix"); + if (url.contains(FEEDBURNER_URL)) { + Log.d(TAG, + "URL seems to be Feedburner URL; appending prefix"); builder.append(FEEDBURNER_PREFIX); } - return builder.toString(); + return builder.toString(); } }