PIVOT-1032: Fix the "HideUtilityClassConstructor" as much as useful, and fix
other style errors in these files also.
git-svn-id: https://svn.apache.org/repos/asf/pivot/trunk@1837916 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/core/src/org/apache/pivot/util/MessageBus.java b/core/src/org/apache/pivot/util/MessageBus.java
index c0fb87c..42bed92 100644
--- a/core/src/org/apache/pivot/util/MessageBus.java
+++ b/core/src/org/apache/pivot/util/MessageBus.java
@@ -21,7 +21,14 @@
/**
* Provides support for basic intra-application message passing.
*/
-public class MessageBus {
+public final class MessageBus {
+ /**
+ * Private constructor for utility class.
+ */
+ private MessageBus() {
+ }
+
+ /** The master list of topics and their listeners. */
private static HashMap<Class<?>, ListenerList<MessageBusListener<?>>> messageTopics = new HashMap<>();
/**
@@ -31,7 +38,7 @@
* @param topic The topic class to subscribe to.
* @param messageListener The listener we want to attach.
*/
- public static <T> void subscribe(Class<? super T> topic, MessageBusListener<T> messageListener) {
+ public static <T> void subscribe(final Class<? super T> topic, final MessageBusListener<T> messageListener) {
ListenerList<MessageBusListener<?>> topicListeners = messageTopics.get(topic);
if (topicListeners == null) {
@@ -52,7 +59,7 @@
* @param messageListener The listener to unsubscribe.
* @throws IllegalArgumentException if there are no listeners subscribed.
*/
- public static <T> void unsubscribe(Class<? super T> topic, MessageBusListener<T> messageListener) {
+ public static <T> void unsubscribe(final Class<? super T> topic, final MessageBusListener<T> messageListener) {
ListenerList<MessageBusListener<?>> topicListeners = messageTopics.get(topic);
if (topicListeners == null) {
@@ -72,7 +79,7 @@
* @param message The message to send to all subscribed listeners.
*/
@SuppressWarnings("unchecked")
- public static <T> void sendMessage(T message) {
+ public static <T> void sendMessage(final T message) {
Class<?> topic = message.getClass();
ListenerList<MessageBusListener<?>> topicListeners = messageTopics.get(topic);
diff --git a/core/src/org/apache/pivot/util/Service.java b/core/src/org/apache/pivot/util/Service.java
index e7c9d03..a1b69a3 100644
--- a/core/src/org/apache/pivot/util/Service.java
+++ b/core/src/org/apache/pivot/util/Service.java
@@ -24,7 +24,13 @@
/**
* Utility class for locating and instantiating service providers.
*/
-public class Service {
+public final class Service {
+ /**
+ * Private constructor for utility class.
+ */
+ private Service() {
+ }
+
/**
* Attempts to load a service provider.
*
@@ -39,7 +45,7 @@
* cannot be found or loaded.
*/
@SuppressWarnings("resource")
- public static Object getProvider(String providerName) {
+ public static Object getProvider(final String providerName) {
String providerClassName = null;
// First look for a system property
diff --git a/core/src/org/apache/pivot/xml/XML.java b/core/src/org/apache/pivot/xml/XML.java
index 1d7f12b..675f92b 100644
--- a/core/src/org/apache/pivot/xml/XML.java
+++ b/core/src/org/apache/pivot/xml/XML.java
@@ -23,7 +23,13 @@
/**
* Contains utility methods for working with XML structures.
*/
-public class XML {
+public final class XML {
+ /**
+ * Private constructor for utility class.
+ */
+ private XML() {
+ }
+
/**
* Returns the element matching a given path.
*
@@ -35,7 +41,7 @@
* element at index 0).
* @return The matching element, or {@code null} if no such element exists.
*/
- public static Element getElement(Element root, String path) {
+ public static Element getElement(final Element root, final String path) {
Utils.checkNull(root, "root");
Utils.checkNullOrEmpty(path, "path");
@@ -104,7 +110,7 @@
* @see #getElement(Element, String)
* @see Element#getElements(String)
*/
- public static List<Element> getElements(Element root, String path, String name) {
+ public static List<Element> getElements(final Element root, final String path, final String name) {
Element element = getElement(root, path);
return (element == null) ? null : element.getElements(name);
}
@@ -119,7 +125,7 @@
* @see #getElement(Element, String)
* @see Element#getText()
*/
- public static String getText(Element root, String path) {
+ public static String getText(final Element root, final String path) {
Element element = getElement(root, path);
return (element == null) ? null : element.getText();
}
diff --git a/wtk/src/org/apache/pivot/wtk/FontUtilities.java b/wtk/src/org/apache/pivot/wtk/FontUtilities.java
index 8377436..ce18509 100644
--- a/wtk/src/org/apache/pivot/wtk/FontUtilities.java
+++ b/wtk/src/org/apache/pivot/wtk/FontUtilities.java
@@ -25,7 +25,13 @@
/**
* Utility class for dealing with fonts.
*/
-public class FontUtilities {
+public final class FontUtilities {
+
+ /**
+ * Private constructor for utility class.
+ */
+ private FontUtilities() {
+ }
/**
* Interpret a string as a font specification.
@@ -37,7 +43,7 @@
* @throws IllegalArgumentException if the given string is <tt>null</tt>
* or empty or the font specification cannot be decoded.
*/
- public static Font decodeFont(String value) {
+ public static Font decodeFont(final String value) {
Utils.checkNullOrEmpty(value, "font");
Font font;
diff --git a/wtk/src/org/apache/pivot/wtk/Keyboard.java b/wtk/src/org/apache/pivot/wtk/Keyboard.java
index abec9df..2cf4531 100644
--- a/wtk/src/org/apache/pivot/wtk/Keyboard.java
+++ b/wtk/src/org/apache/pivot/wtk/Keyboard.java
@@ -30,6 +30,12 @@
*/
public final class Keyboard {
/**
+ * Private constructor for utility class.
+ */
+ private Keyboard() {
+ }
+
+ /**
* Enumeration representing keyboard modifiers.
*/
public enum Modifier {
@@ -63,7 +69,7 @@
public static final String COMMAND_ABBREVIATION = "CMD";
- public KeyStroke(int keyCode, int modifiers) {
+ public KeyStroke(final int keyCode, final int modifiers) {
this.keyCode = keyCode;
this.keyModifiers = modifiers;
}
@@ -77,7 +83,7 @@
}
@Override
- public boolean equals(Object object) {
+ public boolean equals(final Object object) {
boolean equals = false;
if (object instanceof KeyStroke) {
@@ -127,7 +133,7 @@
return KeyEvent.getKeyText(keyCode);
}
- public static KeyStroke decode(String value) {
+ public static KeyStroke decode(final String value) {
Utils.checkNull(value, "value");
int keyCode = KeyCode.UNDEFINED;
@@ -278,7 +284,7 @@
return modifiers;
}
- protected static void setModifiers(int modifiers) {
+ protected static void setModifiers(final int modifiers) {
Keyboard.modifiers = modifiers;
}
@@ -289,7 +295,7 @@
* @return <tt>true</tt> if the modifier is pressed; <tt>false</tt>,
* otherwise.
*/
- public static boolean isPressed(Modifier modifier) {
+ public static boolean isPressed(final Modifier modifier) {
return (modifiers & modifier.getMask()) > 0;
}
@@ -300,7 +306,7 @@
* @return <tt>true</tt> if any of them are pressed, <tt>false</tt>
* if none are pressed.
*/
- public static boolean areAnyPressed(Set<Modifier> modifiers) {
+ public static boolean areAnyPressed(final Set<Modifier> modifiers) {
boolean result = false;
for (Modifier modifier : modifiers) {
if (isPressed(modifier)) {
diff --git a/wtk/src/org/apache/pivot/wtk/Mouse.java b/wtk/src/org/apache/pivot/wtk/Mouse.java
index 77b28c7..ecdc091 100644
--- a/wtk/src/org/apache/pivot/wtk/Mouse.java
+++ b/wtk/src/org/apache/pivot/wtk/Mouse.java
@@ -25,6 +25,12 @@
*/
public final class Mouse {
/**
+ * Private constructor for utility class.
+ */
+ private Mouse() {
+ }
+
+ /**
* Enumeration representing mouse buttons.
*/
public enum Button {
@@ -53,7 +59,7 @@
return buttons;
}
- protected static void setButtons(int buttons) {
+ protected static void setButtons(final int buttons) {
Mouse.buttons = buttons;
}
@@ -63,7 +69,7 @@
* @param button The button to test.
* @return <tt>true</tt> if the button is pressed; <tt>false</tt>, otherwise.
*/
- public static boolean isPressed(Button button) {
+ public static boolean isPressed(final Button button) {
return (buttons & button.getMask()) > 0;
}
@@ -81,7 +87,7 @@
* @param capturerArgument The component that wants to capture the mouse.
* The mouse pointer must currently be over the component.
*/
- public static void capture(Component capturerArgument) {
+ public static void capture(final Component capturerArgument) {
Utils.checkNull(capturerArgument, "capturer");
if (!capturerArgument.isMouseOver()) {
@@ -157,79 +163,64 @@
int cursorID = displayHost.getCursor().getType();
switch (cursorID) {
- case java.awt.Cursor.DEFAULT_CURSOR: {
+ case java.awt.Cursor.DEFAULT_CURSOR:
cursor = Cursor.DEFAULT;
break;
- }
- case java.awt.Cursor.HAND_CURSOR: {
+ case java.awt.Cursor.HAND_CURSOR:
cursor = Cursor.HAND;
break;
- }
- case java.awt.Cursor.TEXT_CURSOR: {
+ case java.awt.Cursor.TEXT_CURSOR:
cursor = Cursor.TEXT;
break;
- }
- case java.awt.Cursor.WAIT_CURSOR: {
+ case java.awt.Cursor.WAIT_CURSOR:
cursor = Cursor.WAIT;
break;
- }
- case java.awt.Cursor.CROSSHAIR_CURSOR: {
+ case java.awt.Cursor.CROSSHAIR_CURSOR:
cursor = Cursor.CROSSHAIR;
break;
- }
- case java.awt.Cursor.MOVE_CURSOR: {
+ case java.awt.Cursor.MOVE_CURSOR:
cursor = Cursor.MOVE;
break;
- }
- case java.awt.Cursor.N_RESIZE_CURSOR: {
+ case java.awt.Cursor.N_RESIZE_CURSOR:
cursor = Cursor.RESIZE_NORTH;
break;
- }
- case java.awt.Cursor.S_RESIZE_CURSOR: {
+ case java.awt.Cursor.S_RESIZE_CURSOR:
cursor = Cursor.RESIZE_SOUTH;
break;
- }
- case java.awt.Cursor.E_RESIZE_CURSOR: {
+ case java.awt.Cursor.E_RESIZE_CURSOR:
cursor = Cursor.RESIZE_EAST;
break;
- }
- case java.awt.Cursor.W_RESIZE_CURSOR: {
+ case java.awt.Cursor.W_RESIZE_CURSOR:
cursor = Cursor.RESIZE_WEST;
break;
- }
- case java.awt.Cursor.NE_RESIZE_CURSOR: {
+ case java.awt.Cursor.NE_RESIZE_CURSOR:
cursor = Cursor.RESIZE_NORTH_EAST;
break;
- }
- case java.awt.Cursor.SW_RESIZE_CURSOR: {
+ case java.awt.Cursor.SW_RESIZE_CURSOR:
cursor = Cursor.RESIZE_SOUTH_WEST;
break;
- }
- case java.awt.Cursor.NW_RESIZE_CURSOR: {
+ case java.awt.Cursor.NW_RESIZE_CURSOR:
cursor = Cursor.RESIZE_NORTH_WEST;
break;
- }
- case java.awt.Cursor.SE_RESIZE_CURSOR: {
+ case java.awt.Cursor.SE_RESIZE_CURSOR:
cursor = Cursor.RESIZE_SOUTH_EAST;
break;
- }
- default: {
+ default:
throw new IllegalArgumentException("Unknown mouse cursor type " + cursorID);
- }
}
return cursor;
@@ -242,7 +233,7 @@
* @throws IllegalArgumentException if the cursor value is {@code null}.
* @throws IllegalStateException If the mouse is not currently captured.
*/
- public static void setCursor(Cursor cursor) {
+ public static void setCursor(final Cursor cursor) {
Utils.checkNull(cursor, "cursor");
if (capturer == null) {
@@ -290,83 +281,68 @@
}
}
- private static java.awt.Cursor getCursor(Cursor cursor) {
+ private static java.awt.Cursor getCursor(final Cursor cursor) {
int cursorID = -1;
switch (cursor) {
- case DEFAULT: {
+ case DEFAULT:
cursorID = java.awt.Cursor.DEFAULT_CURSOR;
break;
- }
- case HAND: {
+ case HAND:
cursorID = java.awt.Cursor.HAND_CURSOR;
break;
- }
- case TEXT: {
+ case TEXT:
cursorID = java.awt.Cursor.TEXT_CURSOR;
break;
- }
- case WAIT: {
+ case WAIT:
cursorID = java.awt.Cursor.WAIT_CURSOR;
break;
- }
- case CROSSHAIR: {
+ case CROSSHAIR:
cursorID = java.awt.Cursor.CROSSHAIR_CURSOR;
break;
- }
- case MOVE: {
+ case MOVE:
cursorID = java.awt.Cursor.MOVE_CURSOR;
break;
- }
- case RESIZE_NORTH: {
+ case RESIZE_NORTH:
cursorID = java.awt.Cursor.N_RESIZE_CURSOR;
break;
- }
- case RESIZE_SOUTH: {
+ case RESIZE_SOUTH:
cursorID = java.awt.Cursor.S_RESIZE_CURSOR;
break;
- }
- case RESIZE_EAST: {
+ case RESIZE_EAST:
cursorID = java.awt.Cursor.E_RESIZE_CURSOR;
break;
- }
- case RESIZE_WEST: {
+ case RESIZE_WEST:
cursorID = java.awt.Cursor.W_RESIZE_CURSOR;
break;
- }
- case RESIZE_NORTH_EAST: {
+ case RESIZE_NORTH_EAST:
cursorID = java.awt.Cursor.NE_RESIZE_CURSOR;
break;
- }
- case RESIZE_SOUTH_WEST: {
+ case RESIZE_SOUTH_WEST:
cursorID = java.awt.Cursor.SW_RESIZE_CURSOR;
break;
- }
- case RESIZE_NORTH_WEST: {
+ case RESIZE_NORTH_WEST:
cursorID = java.awt.Cursor.NW_RESIZE_CURSOR;
break;
- }
- case RESIZE_SOUTH_EAST: {
+ case RESIZE_SOUTH_EAST:
cursorID = java.awt.Cursor.SE_RESIZE_CURSOR;
break;
- }
- default: {
+ default:
throw new IllegalArgumentException("Unknown mouse cursor type " + cursor.toString());
- }
}
return new java.awt.Cursor(cursorID);
