- Timestamp:
- 2016-01-01T17:01:08+01:00 (9 years ago)
- Location:
- trunk/src/org/openstreetmap/josm
- Files:
-
- 28 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/org/openstreetmap/josm/data/conflict/Conflict.java
r9230 r9239 17 17 * {@link OsmPrimitive} from the dataset in another layer or the one retrieved from the server.</li> 18 18 * </ul> 19 * @param <T> primitive type of the conflict 19 20 * @since 1750 20 21 */ -
trunk/src/org/openstreetmap/josm/data/osm/event/DataSetListener.java
r8419 r9239 61 61 * Called after big changes in dataset. Usually other events are stopped using Dataset.beginUpdate() and 62 62 * after operation is completed (Dataset.endUpdate()), {@link #dataChanged(DataChangedEvent event)} is called. 63 * @param event data change event 63 64 */ 64 65 void dataChanged(DataChangedEvent event); -
trunk/src/org/openstreetmap/josm/data/validation/routines/DomainValidator.java
r8870 r9239 121 121 } 122 122 123 /** Private constructor. */ 123 /** 124 * Private constructor. 125 * @param allowLocal whether to allow local domains 126 */ 124 127 private DomainValidator(boolean allowLocal) { 125 128 this.allowLocal = allowLocal; -
trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/MarkerProducers.java
r8806 r9239 23 23 * @param relativePath An path to use for constructing relative URLs or 24 24 * <code>null</code> for no relative URLs 25 * @param parentLayer parent marker layer 26 * @param time Absolute time of marker in seconds since epoch 27 * @param offset Time offset in seconds from the gpx point from which it was derived 25 28 * @return A collection of Marker objects, or <code>null</code>. 26 29 */ -
trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/PlayHeadMarker.java
r9214 r9239 113 113 /** 114 114 * reinstate the old map mode after switching temporarily to do a play head drag 115 * @param reset whether to reset state (pause audio and restore old coordinates) 115 116 */ 116 117 private void endDrag(boolean reset) { … … 182 183 endDrag(true); 183 184 } else { 184 setCoor(cw.getCoor()); 185 ca.play(cw.time - ca.time); 185 if (cw != null) { 186 setCoor(cw.getCoor()); 187 ca.play(cw.time - ca.time); 188 } 186 189 endDrag(false); 187 190 } -
trunk/src/org/openstreetmap/josm/gui/mappaint/ElemStyle.java
r8882 r9239 64 64 * @param c the cascade 65 65 * @param key property key for the width value 66 * @param relativeTo reference width. Only needed, when relative width syntax 67 * is used, e.g. "+4".66 * @param relativeTo reference width. Only needed, when relative width syntax is used, e.g. "+4". 67 * @return width 68 68 */ 69 69 protected static Float getWidth(Cascade c, String key, Float relativeTo) { -
trunk/src/org/openstreetmap/josm/gui/mappaint/ElemStyles.java
r9114 r9239 81 81 * Automatically adds default styles in case no proper style was found. 82 82 * Uses the cache, if possible, and saves the results to the cache. 83 * @param osm OSM primitive 84 * @param scale scale 85 * @param nc navigatable component 86 * @return pair containing style list and range 83 87 */ 84 88 public Pair<StyleList, Range> getStyleCacheWithRange(OsmPrimitive osm, double scale, NavigatableComponent nc) { … … 169 173 * or area) If not, add a default line style from the area color of the multipolygon. 170 174 * 175 * @param osm OSM primitive 176 * @param scale scale 177 * @param nc navigatable component 178 * @return pair containing style list and range 171 179 */ 172 180 private Pair<StyleList, Range> getImpl(OsmPrimitive osm, double scale, NavigatableComponent nc) { … … 372 380 /** 373 381 * Draw a default node symbol for nodes that have no style? 382 * @return {@code true} if default node symbol must be drawn 374 383 */ 375 384 private boolean isDefaultNodes() { … … 383 392 /** 384 393 * Draw a default line for ways that do not have an own line style? 394 * @return {@code true} if default line must be drawn 385 395 */ 386 396 private boolean isDefaultLines() { … … 422 432 /** 423 433 * add a style source; only accessed from MapPaintStyles 434 * @param style style source to add 424 435 */ 425 436 void add(StyleSource style) { … … 429 440 /** 430 441 * set the style sources; only accessed from MapPaintStyles 442 * @param sources new style sources 431 443 */ 432 444 void setStyleSources(Collection<StyleSource> sources) { -
trunk/src/org/openstreetmap/josm/gui/mappaint/Environment.java
r8840 r9239 53 53 /** 54 54 * Creates a new environment. 55 * @param osm OSM primitive 55 56 * @since 8415 56 57 */ … … 61 62 /** 62 63 * Creates a new environment. 64 * @param osm OSM primitive 65 * @param mc multi cascade 66 * @param layer layer 67 * @param source style source 63 68 */ 64 69 public Environment(OsmPrimitive osm, MultiCascade mc, String layer, StyleSource source) { … … 90 95 /** 91 96 * Creates a clone of this environment, with the specified primitive. 97 * @param osm OSM primitive 92 98 * @return A clone of this environment, with the specified primitive 93 99 * @see #osm … … 177 183 /** 178 184 * Creates a clone of this environment, with the specified {@link Context}. 185 * @param context context 179 186 * @return A clone of this environment, with the specified {@code Context} 180 187 */ -
trunk/src/org/openstreetmap/josm/gui/mappaint/MapPaintStyles.java
r9078 r9239 150 150 /** 151 151 * No icon with the given name was found, show a dummy icon instead 152 * @param source style source 152 153 * @return the icon misc/no_icon.png, in descending priority: 153 154 * - relative to source file -
trunk/src/org/openstreetmap/josm/gui/mappaint/MultiCascade.java
r9078 r9239 31 31 * a new layer with that name and return it. The new layer will be 32 32 * a clone of the "*" layer, if it exists. 33 * @param layer layer 34 * @return cascade 33 35 */ 34 36 public Cascade getOrCreateCascade(String layer) { … … 52 54 53 55 /** 54 * Read-only version of getOrCreateCascade. For convenience, it returns an56 * Read-only version of {@link #getOrCreateCascade}. For convenience, it returns an 55 57 * empty cascade for non-existing layers. However this empty (read-only) cascade 56 58 * is not added to this MultiCascade object. 59 * @param layer layer 60 * @return cascade 57 61 */ 58 62 public Cascade getCascade(String layer) { -
trunk/src/org/openstreetmap/josm/gui/mappaint/Range.java
r8958 r9239 55 55 * 56 56 * result (----------------] 57 * @param x value 58 * @param other other range 59 * @return reduced range 57 60 */ 58 61 public Range reduceAround(double x, Range other) { -
trunk/src/org/openstreetmap/josm/gui/mappaint/StyleCache.java
r9078 r9239 103 103 /** 104 104 * looks up styles for a certain scale value 105 * @param scale scale 106 * @return style list 105 107 */ 106 108 public StyleList get(double scale) { … … 118 120 * looks up styles for a certain scale value and additionally returns 119 121 * the scale range for the returned styles 122 * @param scale scale 123 * @return pair containing syle list and range 120 124 */ 121 125 public Pair<StyleList, Range> getWithRange(double scale) { … … 137 141 * add a new styles to the cache. this is only possible, if 138 142 * for this scale range, there is nothing in the cache yet. 143 * @param sl style list 144 * @param lower lower bound 145 * @param upper upper bound 146 * @return interned style cache 139 147 */ 140 148 public StyleCache put(StyleList sl, double lower, double upper) { … … 165 173 * (--------] 166 174 * lower upper 175 * @param sl style list 176 * @param lower lower bound 177 * @param upper upper bound 167 178 */ 168 179 private void putImpl(StyleList sl, double lower, double upper) { … … 227 238 /** 228 239 * Like String.intern() (reduce memory consumption). 229 * StyleCache must not be changed after it has 230 * been added to the intern pool.240 * StyleCache must not be changed after it has been added to the intern pool. 241 * @return style cache 231 242 */ 232 243 public StyleCache intern() { -
trunk/src/org/openstreetmap/josm/gui/mappaint/TextElement.java
r8510 r9239 76 76 * 77 77 * @param c the style properties 78 * @return the label composition strategy 78 * @param defaultAnnotate whether to return {@link #AUTO_LABEL_COMPOSITION_STRATEGY} if not strategy is found 79 * @return the label composition strategy, or {@code null} 79 80 */ 80 81 protected static LabelCompositionStrategy buildLabelCompositionStrategy(Cascade c, boolean defaultAnnotate) { -
trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/ExpressionFactory.java
r9114 r9239 402 402 * @param env the environment 403 403 * @param key the property key 404 * @param layer layer 404 405 * @return the property value 405 406 */ … … 422 423 * @param env the environment 423 424 * @param key the property key 425 * @param layer layer 424 426 * @return {@code true} if the property is set, {@code false} otherwise 425 427 */ … … 676 678 * Obtains the JOSM'key {@link org.openstreetmap.josm.data.Preferences} string for key {@code key}, 677 679 * and defaults to {@code def} if that is null. 680 * @param env the environment 678 681 * @param key Key in JOSM preference 679 682 * @param def Default value … … 1135 1138 /** 1136 1139 * Constructs a new {@code ParameterFunction}. 1140 * @param m method 1141 * @param args arguments 1142 * @param needsEnvironment whether function needs environment 1137 1143 */ 1138 1144 public ParameterFunction(Method m, List<Expression> args, boolean needsEnvironment) { … … 1208 1214 /** 1209 1215 * Constructs a new {@code ArrayFunction}. 1216 * @param m method 1217 * @param args arguments 1210 1218 */ 1211 1219 public ArrayFunction(Method m, List<Expression> args) { -
trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/MapCSSParser.jj
r9099 r9239 52 52 * 53 53 */ 54 55 54 public class MapCSSParser { 56 55 MapCSSStyleSource sheet; … … 77 76 /** 78 77 * Constructor which initializes the parser with a certain lexical state. 78 * @param in input 79 * @param encoding contents encoding 80 * @param initState initial state 79 81 */ 80 82 public MapCSSParser(InputStream in, String encoding, LexicalState initState) { … … 95 97 /** 96 98 * Constructor which initializes the parser with a certain lexical state. 99 * @param in input 100 * @param initState initial state 97 101 */ 98 102 public MapCSSParser(Reader in, LexicalState initState) { … … 108 112 PARSER_END(MapCSSParser) 109 113 110 /** ***********114 /** 111 115 * Token definitions 112 116 * … … 222 226 223 227 224 /************* 225 * 228 /* 226 229 * Preprocessor parser definitions: 227 230 * … … 243 246 /** 244 247 * root method for the preprocessor. 248 * @param sheet MapCSS style source 249 * @return result string 250 * @throws ParseException in case of parsing error 245 251 */ 246 252 String pp_root(MapCSSStyleSource sheet): … … 260 266 * 261 267 * @param write false if this content should be skipped (@pp_media condition is not fulfilled), true otherwise 268 * @throws ParseException in case of parsing error 262 269 */ 263 270 void pp_black_box(boolean write): … … 284 291 * @param ignore if the content of this rule should be ignored 285 292 * (because we are already inside a @supports block that didn't pass) 293 * @throws ParseException in case of parsing error 286 294 */ 287 295 void pp_supports(boolean ignore): … … 302 310 * Unlike other parsing rules, grabs trailing whitespace. 303 311 * @return true, if the condition is fulfilled 312 * @throws ParseException in case of parsing error 304 313 */ 305 314 boolean pp_supports_condition(): … … 329 338 * 330 339 * @return true, if the condition is fulfilled 340 * @throws ParseException in case of parsing error 331 341 */ 332 342 boolean pp_supports_condition_in_parens(): … … 350 360 * 351 361 * @return true if the condition is fulfilled 362 * @throws ParseException in case of parsing error 352 363 */ 353 364 boolean pp_supports_declaration_condition(): … … 411 422 * 412 423 * @return true if the condition is fulfilled 424 * @throws ParseException in case of parsing error 413 425 */ 414 426 // deprecated … … 443 455 } 444 456 445 /************* 446 * 457 /* 447 458 * Parser definition for the main MapCSS parser: 448 459 * … … 542 553 /** 543 554 * white-space 555 * @throws ParseException in case of parsing error 544 556 */ 545 557 void s() : … … 552 564 /** 553 565 * mix of white-space and comments 566 * @throws ParseException in case of parsing error 554 567 */ 555 568 void w() : … … 562 575 /** 563 576 * comma delimited list of floats (at least 2, all >= 0) 577 * @return list of floats 578 * @throws ParseException in case of parsing error 564 579 */ 565 580 List<Float> float_array() : … … 581 596 /** 582 597 * entry point for the main parser 598 * @param sheet MapCSS style source 599 * @throws ParseException in case of parsing error 583 600 */ 584 601 void sheet(MapCSSStyleSource sheet): -
trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/Selector.java
r9078 r9239 94 94 95 95 /** 96 * 96 * Constructs a new {@code ChildOrParentSelector}. 97 97 * @param a the first selector 98 * @param link link 98 99 * @param b the second selector 99 100 * @param type the selector type -
trunk/src/org/openstreetmap/josm/gui/mappaint/xml/LinemodPrototype.java
r8513 r9239 31 31 } 32 32 33 /** get width for overlays */ 33 /** 34 * get width for overlays 35 * @param ref reference width 36 * @return width according to {@link #widthMode} with a minimal value of 1 37 */ 34 38 public float getWidth(float ref) { 35 39 float res; -
trunk/src/org/openstreetmap/josm/gui/mappaint/xml/XmlStyleSource.java
r8870 r9239 140 140 * @param scale ignored if null, otherwise checks if scale is within the range of candidate 141 141 * @param mc side effect: update the valid region for the current MultiCascade 142 * @return {@code true} if {@code candidate} is better than the current match 142 143 */ 143 144 private static boolean requiresUpdate(Prototype current, Prototype candidate, Double scale, MultiCascade mc) { … … 181 182 182 183 /** 184 * @param primitive OSM primitive 183 185 * @param closed The primitive is a closed way or we pretend it is closed. 184 186 * This is useful for multipolygon relations and outer ways of untagged -
trunk/src/org/openstreetmap/josm/gui/preferences/PreferenceTabbedPane.java
r9075 r9239 274 274 * Construct a PreferencePanel for the preference settings. Layout is GridBagLayout 275 275 * and a centered title label and the description are added. 276 * @param caller Preference settings, that display a top level tab 276 277 * @return The created panel ready to add other controls. 277 278 */ … … 283 284 * Construct a PreferencePanel for the preference settings. Layout is GridBagLayout 284 285 * and a centered title label and the description are added. 286 * @param caller Preference settings, that display a top level tab 285 287 * @param inScrollPane if <code>true</code> the added tab will show scroll bars 286 288 * if the panel content is larger than the available space … … 288 290 */ 289 291 public PreferencePanel createPreferenceTab(TabPreferenceSetting caller, boolean inScrollPane) { 290 CheckParameterUtil.ensureParameterNotNull(caller );292 CheckParameterUtil.ensureParameterNotNull(caller, "caller"); 291 293 PreferencePanel p = new PreferencePanel(caller); 292 294 -
trunk/src/org/openstreetmap/josm/gui/preferences/SourceEditor.java
r9078 r9239 416 416 417 417 /** 418 * Provide the GUI strings. (There are differences for MapPaint and Preset) 418 * Provide the GUI strings. (There are differences for MapPaint, Preset and TagChecker Rule) 419 * @param ident any {@link I18nString} value 420 * @return the translated string for {@code ident} 419 421 */ 420 422 protected abstract String getStr(I18nString ident); … … 423 425 * Identifiers for strings that need to be provided. 424 426 */ 425 public enum I18nString { AVAILABLE_SOURCES, ACTIVE_SOURCES, NEW_SOURCE_ENTRY_TOOLTIP, NEW_SOURCE_ENTRY, 426 REMOVE_SOURCE_TOOLTIP, EDIT_SOURCE_TOOLTIP, ACTIVATE_TOOLTIP, RELOAD_ALL_AVAILABLE, 427 LOADING_SOURCES_FROM, FAILED_TO_LOAD_SOURCES_FROM, FAILED_TO_LOAD_SOURCES_FROM_HELP_TOPIC, 428 ILLEGAL_FORMAT_OF_ENTRY } 427 public enum I18nString { 428 /** Available (styles|presets|rules) */ 429 AVAILABLE_SOURCES, 430 /** Active (styles|presets|rules) */ 431 ACTIVE_SOURCES, 432 /** Add a new (style|preset|rule) by entering filename or URL */ 433 NEW_SOURCE_ENTRY_TOOLTIP, 434 /** New (style|preset|rule) entry */ 435 NEW_SOURCE_ENTRY, 436 /** Remove the selected (styles|presets|rules) from the list of active (styles|presets|rules) */ 437 REMOVE_SOURCE_TOOLTIP, 438 /** Edit the filename or URL for the selected active (style|preset|rule) */ 439 EDIT_SOURCE_TOOLTIP, 440 /** Add the selected available (styles|presets|rules) to the list of active (styles|presets|rules) */ 441 ACTIVATE_TOOLTIP, 442 /** Reloads the list of available (styles|presets|rules) */ 443 RELOAD_ALL_AVAILABLE, 444 /** Loading (style|preset|rule) sources */ 445 LOADING_SOURCES_FROM, 446 /** Failed to load the list of (style|preset|rule) sources */ 447 FAILED_TO_LOAD_SOURCES_FROM, 448 /** /Preferences/(Styles|Presets|Rules)#FailedToLoad(Style|Preset|Rule)Sources */ 449 FAILED_TO_LOAD_SOURCES_FROM_HELP_TOPIC, 450 /** Illegal format of entry in (style|preset|rule) list */ 451 ILLEGAL_FORMAT_OF_ENTRY 452 } 429 453 430 454 public boolean hasActiveSourcesChanged() { -
trunk/src/org/openstreetmap/josm/gui/preferences/SubPreferenceSetting.java
r8958 r9239 12 12 /** 13 13 * Returns the preference setting (displayed in the specified preferences tab pane) that contains this preference setting. 14 * @param gui preferences tabbed pane 14 15 * @return parent preference setting 15 16 */ -
trunk/src/org/openstreetmap/josm/gui/preferences/ToolbarPreferences.java
r9078 r9239 1018 1018 1019 1019 /** 1020 * @param action Action to register 1020 1021 * @return The parameter (for better chaining) 1021 1022 */ -
trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ExportProfileAction.java
r8846 r9239 34 34 /** 35 35 * Constructs a new {@code ExportProfileAction}. 36 * @param prefs preferences 37 * @param schemaKey filename prefix 38 * @param prefPattern preference key pattern used to determine which entries are exported 36 39 */ 37 40 public ExportProfileAction(Preferences prefs, String schemaKey, String prefPattern) { … … 67 70 @Override 68 71 public boolean accept(File f) { 69 return f.isDirectory() || Utils.hasExtension(f, "xml") && f.getName().toLowerCase(Locale.ENGLISH).startsWith(schemaKey);72 return f.isDirectory() || (Utils.hasExtension(f, "xml") && f.getName().toLowerCase(Locale.ENGLISH).startsWith(schemaKey)); 70 73 } 71 74 -
trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ListEditor.java
r9078 r9239 36 36 * Constructs a new {@code ListEditor}. 37 37 * @param gui The parent component 38 * @param entry preference entry 39 * @param setting list setting 38 40 */ 39 41 public ListEditor(final JComponent gui, PrefEntry entry, ListSetting setting) { -
trunk/src/org/openstreetmap/josm/gui/preferences/advanced/ListListEditor.java
r9078 r9239 51 51 * Constructs a new {@code ListListEditor}. 52 52 * @param gui The parent component 53 * @param entry preference entry 54 * @param setting list of lists setting 53 55 */ 54 56 public ListListEditor(final JComponent gui, PrefEntry entry, ListListSetting setting) { -
trunk/src/org/openstreetmap/josm/gui/preferences/advanced/StringEditor.java
r9078 r9239 26 26 * Constructs a new {@code StringEditor}. 27 27 * @param gui The parent component 28 * @param entry preference entry 29 * @param setting string setting 28 30 */ 29 31 public StringEditor(final JComponent gui, PrefEntry entry, StringSetting setting) { -
trunk/src/org/openstreetmap/josm/gui/preferences/projection/ListProjectionChoice.java
r8510 r9239 53 53 /** 54 54 * Convert 0-based index to preference value. 55 * @param idx 0-based index 56 * @return preference value 57 * @see #zoneToIndex 55 58 */ 56 59 protected abstract String indexToZone(int idx); … … 58 61 /** 59 62 * Convert preference value to 0-based index. 63 * @param zone preference value 64 * @return 0-based index 65 * @see #indexToZone 60 66 */ 61 67 protected abstract int zoneToIndex(String zone); -
trunk/src/org/openstreetmap/josm/gui/preferences/projection/ProjectionChoice.java
r7937 r9239 58 58 * Will be called when the preference dialog is dismissed or 59 59 * when the listener from getPreferencePanel is invoked. 60 * @param panel projection preferences panel 61 * @return preferences as a list of strings; may be null to reset everything. 62 * @see #setPreferences 60 63 */ 61 64 Collection<String> getPreferences(JPanel panel); … … 82 85 * @return the name 83 86 */ 87 @Override 84 88 String toString(); 85 89 }
Note:
See TracChangeset
for help on using the changeset viewer.