Changeset 30116 in osm for applications/editors/josm/plugins/OpeningHoursEditor

Timestamp:

2013-12-07T21:43:54+01:00 (11 years ago)

Author:

donvip

Message:

[josm_openinghours] code cleanup

Location:

applications/editors/josm/plugins/OpeningHoursEditor/src/org/openstreetmap/josm/plugins/ohe

Files:

• ClockSystem.java (modified) (1 diff)
• gui/OheDialogPanel.java (modified) (5 diffs)
• gui/OheEditor.java (modified) (1 diff)
• gui/TimeRect.java (modified) (4 diffs)
• parser/OpeningTimeCompiler.jj (modified) (1 diff)
• parser/SyntaxException.java (modified) (1 diff)

applications/editors/josm/plugins/OpeningHoursEditor/src/org/openstreetmap/josm/plugins/ohe/ClockSystem.java

@@ -5 +5 @@
 import java.util.Locale;
 
+/**
+ * Clock system (12 or 24 hours).
+ */
 public enum ClockSystem {
-    TWELVE_HOURS, TWENTYFOUR_HOURS;
+    
+    /** 12-hour clock system */
+    TWELVE_HOURS, 
+    /** 24-hour clock system */
+    TWENTYFOUR_HOURS;
 
+    /**
+     * Returns the clock system for the given locale.
+     * @param locale The locale
+     * @return the clock system for the given locale
+     */
     public static ClockSystem getClockSystem(Locale locale) {
         DateFormat stdFormat = DateFormat.getTimeInstance(DateFormat.SHORT, Locale.US);

applications/editors/josm/plugins/OpeningHoursEditor/src/org/openstreetmap/josm/plugins/ohe/gui/OheDialogPanel.java

@@ -120 +120 @@
     }
 
-    // returns the compiled Time from the valueField
+    /**
+     * Returns the compiled Time from the valueField.
+     * @return the compiled Time from the valueField
+     */
     public ArrayList<int[]> getTime() throws Exception {
         String value = valueField.getText();
@@ -138 +141 @@
                     SyntaxException syntaxError = (SyntaxException) t;
                     tColumns = new int[] { syntaxError.getStartColumn(), syntaxError.getEndColumn() };
-                    info = syntaxError.getInfo();
+                    info = syntaxError.getMessage();
                 } else {
+                    info = t.getMessage();
                     Main.warn(t);
                 }
@@ -162 +166 @@
                 }
 
-                throw new Exception("Error in the TimeValue");
+                throw new Exception("Error in the TimeValue", t);
             }
         }
@@ -169 +173 @@
     }
 
-    // updates the valueField with the given timeRects
+    /**
+     * Updates the valueField with the given timeRects.
+     */
     public void updateValueField(ArrayList<TimeRect> timeRects) {
         if (valueField != null && timeRects != null)
@@ -180 +186 @@
 
     /**
-     * @return the hourMode
+     * Returns the clock system (12 or 24 hours).
+     * @return the clock system
      */
     public ClockSystem getHourMode() {

applications/editors/josm/plugins/OpeningHoursEditor/src/org/openstreetmap/josm/plugins/ohe/gui/OheEditor.java

@@ -244 +244 @@
     }
 
-    // removes the given timerect from the panel and from the arraylist
+    /**
+     * Removes the given timerect from the panel and from the arraylist
+     */
     public void removeTimeRect(TimeRect timeRectToRemove) {
         timeRects.remove(timeRectToRemove);

applications/editors/josm/plugins/OpeningHoursEditor/src/org/openstreetmap/josm/plugins/ohe/gui/TimeRect.java

@@ -19 +19 @@
 import javax.swing.JPopupMenu;
 
-public class TimeRect extends JPanel implements MouseListener,
-        MouseMotionListener {
+public class TimeRect extends JPanel implements MouseListener, MouseMotionListener {
+    
     public static final int[] transformCursorTypes = new int[] {
             Cursor.MOVE_CURSOR, Cursor.N_RESIZE_CURSOR,
@@ -53 +53 @@
     private int minuteEnd;
 
-    public TimeRect(OheEditor editor, int dayStart, int dayEnd,
-            int minutesStart, int minutesEnd) {
+    public TimeRect(OheEditor editor, int dayStart, int dayEnd, int minutesStart, int minutesEnd) {
         this.editor = editor;
 
@@ -117 +116 @@
     }
 
-    public static void drawTimeRect(Graphics2D g2D, Rectangle bounds,
-            boolean isZeroMinuteInterval, boolean isOpenEndInterval) {
+    public static void drawTimeRect(Graphics2D g2D, Rectangle bounds, boolean isZeroMinuteInterval, boolean isOpenEndInterval) {
 
         Color innerColor = new Color(135, 135, 234);
@@ -156 +154 @@
     private int transformType;
 
-    // Calculate where the Component was clicked and returns the
-    // transformtype
+    // Calculate where the Component was clicked and returns the transformtype
     private int getTransformType(MouseEvent evt) {
         int tmpClickAreaWidth = Math.min(clickAreaSize, getWidth() / 3);

applications/editors/josm/plugins/OpeningHoursEditor/src/org/openstreetmap/josm/plugins/ohe/parser/OpeningTimeCompiler.jj

@@ -50 +50 @@
 import org.openstreetmap.josm.plugins.ohe.OpeningTimeUtils.DateTime;
 
-public class OpeningTimeCompiler
-{
+public class OpeningTimeCompiler {
+
+  /**
+   * Abbreviated week days.
+   */
   public static final String[] WEEKDAYS = new String[] {"Mo", "Tu", "We", "Th", "Fr", "Sa", "Su"};
-
-  public OpeningTimeCompiler(String time)
-  {
+  /**
+   * Constructs a new OpeningTimeCompiler.
+   */
+  public OpeningTimeCompiler(String time) {
     this(new ByteArrayInputStream(time.getBytes()), null);
   }

applications/editors/josm/plugins/OpeningHoursEditor/src/org/openstreetmap/josm/plugins/ohe/parser/SyntaxException.java

@@ -15 +15 @@
     }
 
-    public String getInfo() {
-        return info;
-    }
-
     public SyntaxException(String info, int startColumn, int endColumn) {
+        super(info);
         this.startColumn = startColumn;
         this.endColumn = endColumn;