Changeset 30114 in osm for applications/editors/josm/plugins

Timestamp:

2013-12-07T21:29:17+01:00 (11 years ago)

Author:

donvip

Message:

[josm_openinghours] code cleanup

Location:

applications/editors/josm/plugins/OpeningHoursEditor

Files:

• .project (modified) (2 diffs)
• .settings/org.eclipse.jdt.core.prefs (modified) (3 diffs)
• .settings/sf.eclipse.javacc.prefs (added)
• src/org/openstreetmap/josm/plugins/ohe/OhePlugin.java (modified) (3 diffs)
• src/org/openstreetmap/josm/plugins/ohe/OpeningTimeUtils.java (modified) (4 diffs)
• src/org/openstreetmap/josm/plugins/ohe/gui/OheDialogPanel.java (modified) (4 diffs)
• src/org/openstreetmap/josm/plugins/ohe/parser/OpeningTimeCompiler.jj (modified) (1 diff)
• src/org/openstreetmap/josm/plugins/ohe/parser/ParseException.java (deleted)
• src/org/openstreetmap/josm/plugins/ohe/parser/SimpleCharStream.java (deleted)
• src/org/openstreetmap/josm/plugins/ohe/parser/Token.java (deleted)
• src/org/openstreetmap/josm/plugins/ohe/parser/TokenMgrError.java (deleted)

applications/editors/josm/plugins/OpeningHoursEditor/.project

@@ -2 +2 @@
 <projectDescription>
         <name>JOSM-OpeningHoursEditor</name>
-        <comment></comment>
+        <comment>Nature JavaCC</comment>
         <projects>
         </projects>
         <buildSpec>
+                <buildCommand>
+                        <name>sf.eclipse.javacc.javaccbuilder</name>
+                        <arguments>
+                        </arguments>
+                </buildCommand>
                 <buildCommand>
                         <name>org.eclipse.jdt.core.javabuilder</name>
@@ -14 +19 @@
         <natures>
                 <nature>org.eclipse.jdt.core.javanature</nature>
+                <nature>sf.eclipse.javacc.javaccnature</nature>
         </natures>
 </projectDescription>

applications/editors/josm/plugins/OpeningHoursEditor/.settings/org.eclipse.jdt.core.prefs

@@ -6 +6 @@
 org.eclipse.jdt.core.compiler.annotation.nullable=org.eclipse.jdt.annotation.Nullable
 org.eclipse.jdt.core.compiler.annotation.nullanalysis=disabled
+org.eclipse.jdt.core.compiler.doc.comment.support=enabled
 org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
 org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
@@ -27 +28 @@
 org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=warning
 org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore
+org.eclipse.jdt.core.compiler.problem.invalidJavadoc=warning
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=enabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=enabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=enabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=public
 org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore
 org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
@@ -33 +39 @@
 org.eclipse.jdt.core.compiler.problem.missingEnumCaseDespiteDefault=disabled
 org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=ignore
+org.eclipse.jdt.core.compiler.problem.missingJavadocComments=warning
+org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=public
 org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore
 org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotationForInterfaceMethodImplementation=enabled

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

@@ -48 +48 @@
 import org.openstreetmap.josm.tools.Shortcut;
 
+/**
+ * Opening hours editor plugin.
+ */
 public class OhePlugin extends Plugin {
+    
     /**
      * Strings for choosing which key of an object with given tags should be
@@ -68 +72 @@
      * Will be invoked by JOSM to bootstrap the plugin
      * 
-     * @param info
-     *            information about the plugin and its local installation
+     * @param info information about the plugin and its local installation
      */
     public OhePlugin(PluginInformation info) {
@@ -79 +82 @@
      * this Action is used for calling the OpeningsHourEditor, the selected
      * objects in the active datalayer are edited
-     * 
-     * @author boman
      */
     class OheMenuAction extends JosmAction {

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

@@ -6 +6 @@
 import org.openstreetmap.josm.plugins.ohe.parser.OpeningTimeCompiler;
 
+/**
+ * Collection of utility methods.
+ */
 public class OpeningTimeUtils {
-    // implements the subtraction of daytimes in spans of days when a day in
-    // the list occurs direct afterwards
+    
+    /**
+     * Implements the subtraction of daytimes in spans of days when a day in the list occurs direct afterwards 
+     */
     public static ArrayList<int[]> convert(ArrayList<DateTime> dateTimes) {
         ArrayList<int[]> ret = new ArrayList<int[]>(); // the list which is
@@ -104 +109 @@
     }
 
-    // returns a String (e.g "Mo-Sa 10:00-20:00; Tu off") representing the
-    // TimeRects
+    /**
+     * Returns a String (e.g "Mo-Sa 10:00-20:00; Tu off") representing the TimeRects
+     */
     public static String makeStringFromRects(ArrayList<TimeRect> givenTimeRects) {
         // create an array of booleans representing every minute on all the days
@@ -178 +184 @@
     }
 
-    // returns a String representing the openinghours on one special day (e.g.
-    // "10:00-20:00")
+    /**
+     * Returns a String representing the openinghours on one special day (e.g. "10:00-20:00")
+     */
     private static String makeStringFromMinuteArray(boolean[] minutes) {
         String ret = "";
@@ -212 +219 @@
 
     /**
+     * 
      * @param minutes integer in range from 0 and 24*60 inclusive
      * @param hourMode 12 or 24 hour clock

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

@@ -17 +17 @@
 import javax.swing.JTextField;
 
+import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.plugins.ohe.ClockSystem;
 import org.openstreetmap.josm.plugins.ohe.OhePlugin;
@@ -23 +24 @@
 import org.openstreetmap.josm.plugins.ohe.parser.ParseException;
 import org.openstreetmap.josm.plugins.ohe.parser.SyntaxException;
-import org.openstreetmap.josm.plugins.ohe.parser.TokenMgrError;
 import org.openstreetmap.josm.tools.GBC;
 
@@ -67 +67 @@
                 value = valuesMap.keySet().iterator().next();
             else if (valuesMap.size() > 1) {
-                // TODO let the user choose which value he wants to edit (e.g.
-                // with a combobox)
+                // TODO let the user choose which value he wants to edit (e.g. with a combobox)
                 int mostOccurences = 0;
                 for (String v : valuesMap.keySet())
@@ -140 +139 @@
                     tColumns = new int[] { syntaxError.getStartColumn(), syntaxError.getEndColumn() };
                     info = syntaxError.getInfo();
-                } else if (t instanceof TokenMgrError) {
-                    TokenMgrError tokenMgrError = (TokenMgrError) t;
-                    tColumns = new int[] { tokenMgrError.errorColumn - 1, tokenMgrError.errorColumn + 1 };
                 } else {
-                    t.printStackTrace();
+                    Main.warn(t);
                 }
 

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

@@ -30 +30 @@
   ERROR_REPORTING = true;
   JAVA_UNICODE_ESCAPE = false;
-  UNICODE_INPUT = false;
+  UNICODE_INPUT = true;
   IGNORE_CASE = false;
   USER_TOKEN_MANAGER = false;