From 263eeac1a50703b048fb0524dd08351c496246d3 Mon Sep 17 00:00:00 2001 From: Paul-Christian Volkmer <paul-christian.volkmer@mni.thm.de> Date: Mon, 2 Jun 2014 13:33:03 +0200 Subject: [PATCH] Some more code style issues fixed --- .../java/de/thm/arsnova/FeedbackStorage.java | 70 +++++++++---------- src/main/java/de/thm/arsnova/ImageUtils.java | 49 ++++++------- .../java/de/thm/arsnova/dao/NovaView.java | 59 ++++++++-------- .../de/thm/arsnova/entities/Question.java | 28 ++++---- 4 files changed, 104 insertions(+), 102 deletions(-) diff --git a/src/main/java/de/thm/arsnova/FeedbackStorage.java b/src/main/java/de/thm/arsnova/FeedbackStorage.java index dcdd11b84..41df30bc2 100644 --- a/src/main/java/de/thm/arsnova/FeedbackStorage.java +++ b/src/main/java/de/thm/arsnova/FeedbackStorage.java @@ -14,14 +14,14 @@ import de.thm.arsnova.exceptions.NotFoundException; public class FeedbackStorage { private static class FeedbackStorageObject { - private int value; - private Date timestamp; - private User user; - - public FeedbackStorageObject(int initValue, User u) { - this.value = initValue; - this.timestamp = new Date(); - this.user = u; + private final int value; + private final Date timestamp; + private final User user; + + public FeedbackStorageObject(final int initValue, final User u) { + value = initValue; + timestamp = new Date(); + user = u; } public int getValue() { @@ -30,21 +30,21 @@ public class FeedbackStorage { public Date getTimestamp() { return timestamp; } - public boolean fromUser(User u) { + public boolean fromUser(final User u) { return u.getUsername().equals(user.getUsername()); } } - - private Map<String, Map<String, FeedbackStorageObject>> data; - - private IDatabaseDao dao; - - public FeedbackStorage(IDatabaseDao newDao) { - this.data = new ConcurrentHashMap<String, Map<String, FeedbackStorageObject>>(); - this.dao = newDao; + + private final IDatabaseDao dao; + + private final Map<String, Map<String, FeedbackStorageObject>> data; + + public FeedbackStorage(final IDatabaseDao newDao) { + data = new ConcurrentHashMap<String, Map<String, FeedbackStorageObject>>(); + dao = newDao; } - public Feedback getFeedback(String keyword) { + public Feedback getFeedback(final String keyword) { int a = 0; int b = 0; int c = 0; @@ -53,12 +53,12 @@ public class FeedbackStorage { if (dao.getSession(keyword) == null) { throw new NotFoundException(); } - + if (data.get(keyword) == null) { return new Feedback(0, 0, 0, 0); } - for (FeedbackStorageObject fso : data.get(keyword).values()) { + for (final FeedbackStorageObject fso : data.get(keyword).values()) { switch (fso.getValue()) { case Feedback.FEEDBACK_FASTER: a++; @@ -79,51 +79,51 @@ public class FeedbackStorage { return new Feedback(a, b, c, d); } - public Integer getMyFeedback(String keyword, User u) { + public Integer getMyFeedback(final String keyword, final User u) { if (data.get(keyword) == null) { return null; } - - for (FeedbackStorageObject fso : data.get(keyword).values()) { + + for (final FeedbackStorageObject fso : data.get(keyword).values()) { if (fso.fromUser(u)) { return fso.getValue(); } } - + return null; } @Transactional(isolation = Isolation.READ_COMMITTED) - public boolean saveFeedback(String keyword, int value, User user) { + public boolean saveFeedback(final String keyword, final int value, final User user) { if (dao.getSession(keyword) == null) { throw new NotFoundException(); } - + if (data.get(keyword) == null) { data.put(keyword, new ConcurrentHashMap<String, FeedbackStorageObject>()); } - + data.get(keyword).put(user.getUsername(), new FeedbackStorageObject(value, user)); return true; } @Transactional(isolation = Isolation.READ_COMMITTED) - public void cleanFeedbackVotes(int cleanupFeedbackDelay) { - for (String keyword : data.keySet()) { - this.cleanSessionFeedbackVotes(keyword, cleanupFeedbackDelay); + public void cleanFeedbackVotes(final int cleanupFeedbackDelay) { + for (final String keyword : data.keySet()) { + cleanSessionFeedbackVotes(keyword, cleanupFeedbackDelay); } } - private void cleanSessionFeedbackVotes(String keyword, int cleanupFeedbackDelay) { + private void cleanSessionFeedbackVotes(final String keyword, final int cleanupFeedbackDelay) { final long timelimitInMillis = 60000 * (long) cleanupFeedbackDelay; final long maxAllowedTimeInMillis = System.currentTimeMillis() - timelimitInMillis; - Map<String, FeedbackStorageObject> sessionFeedbacks = data.get(keyword); + final Map<String, FeedbackStorageObject> sessionFeedbacks = data.get(keyword); - for (Map.Entry<String, FeedbackStorageObject> entry : sessionFeedbacks.entrySet()) { + for (final Map.Entry<String, FeedbackStorageObject> entry : sessionFeedbacks.entrySet()) { if ( - entry.getValue().getTimestamp().getTime() < maxAllowedTimeInMillis - ) { + entry.getValue().getTimestamp().getTime() < maxAllowedTimeInMillis + ) { sessionFeedbacks.remove(entry.getKey()); } } diff --git a/src/main/java/de/thm/arsnova/ImageUtils.java b/src/main/java/de/thm/arsnova/ImageUtils.java index 29c55c70c..d28f980e8 100644 --- a/src/main/java/de/thm/arsnova/ImageUtils.java +++ b/src/main/java/de/thm/arsnova/ImageUtils.java @@ -38,9 +38,10 @@ import org.slf4j.LoggerFactory; * @author Daniel Vogel (daniel.vogel@mni.thm.de) * */ -public class ImageUtils { +public final class ImageUtils { - private ImageUtils() {} + private ImageUtils() { + } public static final Logger LOGGER = LoggerFactory.getLogger(ImageUtils.class); @@ -50,18 +51,17 @@ public class ImageUtils { * @param imageUrl The image url as a {@link String} * @return The Base64 {@link String} of the image on success, otherwise <code>null</code>. */ - public static String encodeImageToString(String imageUrl) { + public static String encodeImageToString(final String imageUrl) { - String[] urlParts = imageUrl.split("\\."); - StringBuilder result = new StringBuilder(); + final String[] urlParts = imageUrl.split("\\."); + final StringBuilder result = new StringBuilder(); // get format // // The format is read dynamically. We have to take control // in the frontend that no unsupported formats are transmitted! - if ( urlParts.length > 0 ) { - - String extension = urlParts[urlParts.length-1]; + if (urlParts.length > 0) { + final String extension = urlParts[urlParts.length - 1]; result.append("data:image/" + extension + ";base64,"); result.append(Base64.encodeBase64String(convertFileToByteArray(imageUrl))); @@ -78,12 +78,12 @@ public class ImageUtils { * @param imageUrl The image url as a {@link String} * @return The <code>byte[]</code> of the image on success, otherwise <code>null</code>. */ - public static byte[] convertImageToByteArray(String imageUrl, String extension) { + public static byte[] convertImageToByteArray(final String imageUrl, final String extension) { try { - URL url = new URL(imageUrl); - BufferedImage image = ImageIO.read(url); - ByteArrayOutputStream baos = new ByteArrayOutputStream(); + final URL url = new URL(imageUrl); + final BufferedImage image = ImageIO.read(url); + final ByteArrayOutputStream baos = new ByteArrayOutputStream(); ImageIO.write(image, extension, baos); @@ -91,9 +91,9 @@ public class ImageUtils { baos.close(); return baos.toByteArray(); - } catch (MalformedURLException e) { + } catch (final MalformedURLException e) { LOGGER.error(e.getLocalizedMessage()); - } catch (IOException e) { + } catch (final IOException e) { LOGGER.error(e.getLocalizedMessage()); } @@ -102,21 +102,23 @@ public class ImageUtils { /** * Gets the bytestream of an image url. - * s + * * @param imageUrl The image url as a {@link String} * @return The <code>byte[]</code> of the image on success, otherwise <code>null</code>. */ - public static byte[] convertFileToByteArray(String imageUrl) { + public static byte[] convertFileToByteArray(final String imageUrl) { + // Or whatever size you want to read in at a time. + final int CHUNK_SIZE = 4096; try { - URL url = new URL(imageUrl); - ByteArrayOutputStream baos = new ByteArrayOutputStream(); + final URL url = new URL(imageUrl); + final ByteArrayOutputStream baos = new ByteArrayOutputStream(); - InputStream is = url.openStream(); - byte[] byteChunk = new byte[4096]; // Or whatever size you want to read in at a time. + final InputStream is = url.openStream(); + final byte[] byteChunk = new byte[CHUNK_SIZE]; int n; - while ( (n = is.read(byteChunk)) > 0 ) { + while ((n = is.read(byteChunk)) > 0 ) { baos.write(byteChunk, 0, n); } @@ -125,13 +127,12 @@ public class ImageUtils { return baos.toByteArray(); - } catch (MalformedURLException e) { + } catch (final MalformedURLException e) { LOGGER.error(e.getLocalizedMessage()); - } catch (IOException e) { + } catch (final IOException e) { LOGGER.error(e.getLocalizedMessage()); } return null; } } - diff --git a/src/main/java/de/thm/arsnova/dao/NovaView.java b/src/main/java/de/thm/arsnova/dao/NovaView.java index e525f06c3..7649b6869 100644 --- a/src/main/java/de/thm/arsnova/dao/NovaView.java +++ b/src/main/java/de/thm/arsnova/dao/NovaView.java @@ -25,64 +25,64 @@ import com.fourspaces.couchdb.View; public class NovaView extends View { - public NovaView(String fullname) { + public NovaView(final String fullname) { super(fullname); } @Override - public void setStartKey(String key) { - this.startKey = quote(key); + public void setStartKey(final String key) { + startKey = quote(key); } - public void setStartKeyArray(String key) { + public void setStartKeyArray(final String key) { if (isNumber(key)) { - this.startKey = encode("[" + key + "]"); + startKey = encode("[" + key + "]"); } else { - this.startKey = encode("[\"" + key + "\"]"); + startKey = encode("[\"" + key + "\"]"); } } - public void setStartKeyArray(String... keys) { + public void setStartKeyArray(final String... keys) { this.setStartKey(keys); } @Override - public void setEndKey(String key) { - this.endKey = quote(key); + public void setEndKey(final String key) { + endKey = quote(key); } - public void setEndKeyArray(String key) { + public void setEndKeyArray(final String key) { if (isNumber(key)) { - this.endKey = encode("[" + key + "]"); + endKey = encode("[" + key + "]"); } else { - this.endKey = encode("[\"" + key + "\"]"); + endKey = encode("[\"" + key + "\"]"); } } - public void setEndKeyArray(String... keys) { + public void setEndKeyArray(final String... keys) { this.setEndKey(keys); } - public void setStartKey(String... keys) { - this.startKey = toJsonArray(keys); + public void setStartKey(final String... keys) { + startKey = toJsonArray(keys); } - public void setEndKey(String... keys) { - this.endKey = toJsonArray(keys); + public void setEndKey(final String... keys) { + endKey = toJsonArray(keys); } @Override - public void setKey(String key) { + public void setKey(final String key) { this.key = quote(key); } - public void setKey(String... keys) { - this.key = toJsonArray(keys); + public void setKey(final String... keys) { + key = toJsonArray(keys); } - private String toJsonArray(String[] strings) { - StringBuilder sb = new StringBuilder(); - for (String str : strings) { + private String toJsonArray(final String[] strings) { + final StringBuilder sb = new StringBuilder(); + for (final String str : strings) { if (isNumber(str)) { sb.append(str + ","); } else if (str.equals("{}")) { @@ -91,26 +91,27 @@ public class NovaView extends View { sb.append("\"" + str + "\"" + ","); } } - sb.replace(sb.length() - 1, sb.length(), ""); // remove final comma + // remove final comma + sb.replace(sb.length() - 1, sb.length(), ""); sb.insert(0, "["); sb.append("]"); return encode(sb.toString()); } - private String quote(String string) { + private String quote(final String string) { return encode("\"" + string + "\""); } - private boolean isNumber(String string) { + private boolean isNumber(final String string) { return string.matches("^[0-9]+$"); } - private String encode(String string) { + private String encode(final String string) { try { return URLEncoder.encode(string, "UTF-8"); - } catch (UnsupportedEncodingException e) { + } catch (final UnsupportedEncodingException e) { // Since we're using 'UTF-8', this should Exception should never occur. + return ""; } - return ""; } } diff --git a/src/main/java/de/thm/arsnova/entities/Question.java b/src/main/java/de/thm/arsnova/entities/Question.java index 8b2d36e30..f8cbbadb9 100644 --- a/src/main/java/de/thm/arsnova/entities/Question.java +++ b/src/main/java/de/thm/arsnova/entities/Question.java @@ -135,22 +135,22 @@ public class Question { } public final void setSession(final String session) { - this.sessionId = session; + sessionId = session; } public final String getSessionKeyword() { - return this.sessionKeyword; + return sessionKeyword; } public final void setSessionKeyword(final String keyword) { - this.sessionKeyword = keyword; + sessionKeyword = keyword; } public final long getTimestamp() { return timestamp; } - public final void setTimestamp(long timestamp) { + public final void setTimestamp(final long timestamp) { this.timestamp = timestamp; } @@ -174,7 +174,7 @@ public class Question { return piRound; } - public void setPiRound(int piRound) { + public void setPiRound(final int piRound) { this.piRound = piRound; } @@ -182,7 +182,7 @@ public class Question { return showStatistic; } - public void setShowStatistic(boolean showStatistic) { + public void setShowStatistic(final boolean showStatistic) { this.showStatistic = showStatistic; } @@ -190,7 +190,7 @@ public class Question { return showAnswer; } - public void setShowAnswer(boolean showAnswer) { + public void setShowAnswer(final boolean showAnswer) { this.showAnswer = showAnswer; } @@ -198,7 +198,7 @@ public class Question { return abstention; } - public void setAbstention(boolean abstention) { + public void setAbstention(final boolean abstention) { this.abstention = abstention; } @@ -222,7 +222,7 @@ public class Question { return image; } - public void setImage(String image) { + public void setImage(final String image) { this.image = image; } @@ -230,7 +230,7 @@ public class Question { return gridSize; } - public void setGridSize(int gridSize) { + public void setGridSize(final int gridSize) { this.gridSize = gridSize; } @@ -238,7 +238,7 @@ public class Question { return offsetX; } - public void setOffsetX(int offsetX) { + public void setOffsetX(final int offsetX) { this.offsetX = offsetX; } @@ -246,7 +246,7 @@ public class Question { return offsetY; } - public void setOffsetY(int offsetY) { + public void setOffsetY(final int offsetY) { this.offsetY = offsetY; } @@ -254,12 +254,12 @@ public class Question { return zoomLvl; } - public void setZoomLvl(int zoomLvl) { + public void setZoomLvl(final int zoomLvl) { this.zoomLvl = zoomLvl; } @Override public final String toString() { - return "Question type '" + this.type + "': " + this.subject + ";\n" + this.text + this.possibleAnswers; + return "Question type '" + type + "': " + subject + ";\n" + text + possibleAnswers; } } -- GitLab