- Timestamp:
- 2016-01-01T22:21:21+01:00 (9 years ago)
- Location:
- trunk/src/org/openstreetmap/josm
- Files:
-
- 26 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java
r9231 r9246 1264 1264 /** 1265 1265 * Returns {@code o} as collection of {@code o}'s type. 1266 * @param <T> object type 1266 1267 * @param o any object 1267 1268 * @return {@code o} as collection of {@code o}'s type. -
trunk/src/org/openstreetmap/josm/data/Preferences.java
r9243 r9246 1338 1338 * Default constructor is used to initialize the struct objects, properties 1339 1339 * then override some of these default values. 1340 * @param <T> klass type 1340 1341 * @param key main preference key 1341 1342 * @param klass The struct class … … 1352 1353 /** 1353 1354 * same as above, but returns def if nothing was found 1355 * @param <T> klass type 1354 1356 * @param key main preference key 1355 1357 * @param def default value -
trunk/src/org/openstreetmap/josm/data/cache/JCSCacheManager.java
r9142 r9246 124 124 /** 125 125 * Returns configured cache object for named cache region 126 * @param <K> key type 127 * @param <V> value type 126 128 * @param cacheName region name 127 129 * @return cache access object … … 134 136 /** 135 137 * Returns configured cache object with defined limits of memory cache and disk cache 138 * @param <K> key type 139 * @param <V> value type 136 140 * @param cacheName region name 137 141 * @param maxMemoryObjects number of objects to keep in memory -
trunk/src/org/openstreetmap/josm/data/gpx/IWithAttributes.java
r7518 r9246 31 31 * Returns the Collection value to which the specified key is mapped, 32 32 * or {@code null} if this map contains no Collection mapping for the key. 33 * @param <T> type of items 33 34 * 34 35 * @param key the key whose associated value is to be returned -
trunk/src/org/openstreetmap/josm/data/osm/Storage.java
r9243 r9246 277 277 /** 278 278 * Finds a bucket for given key. 279 * @param <K> type for hashCode and first equals parameter 279 280 * @param ha hash function 280 281 * … … 350 351 /** 351 352 * A factory for default hash implementation. 352 * @ return a hash implementation that just delegates to object's own353 * hashCode and equals.353 * @param <O> type for hash 354 * @return a hash implementation that just delegates to object's own hashCode and equals. 354 355 */ 355 356 public static <O> Hash<O, O> defaultHash() { -
trunk/src/org/openstreetmap/josm/data/validation/OsmValidator.java
r8882 r9246 229 229 /** 230 230 * Returns the instance of the given test class. 231 * @param <T> testClass type 231 232 * @param testClass The class of test to retrieve 232 233 * @return the instance of the given test class, if any, or {@code null} -
trunk/src/org/openstreetmap/josm/gui/MainMenu.java
r9243 r9246 535 535 * This method handles all the shortcut handling. It also makes sure that actions that are 536 536 * handled by the OS are not duplicated on the menu. 537 * @param <E> group item enum type 537 538 * @param menu to add the action to 538 539 * @param action the action that should get a menu item … … 556 557 * Add a JosmAction to a menu and automatically prints accelerator if available. 557 558 * Also adds a checkbox that may be toggled. 559 * @param <E> group enum item type 558 560 * @param menu to add the action to 559 561 * @param action the action that should get a menu item … … 622 624 /** 623 625 * Adds the given menu on the given position to the main menu. 626 * @param <T> menu type 624 627 * 625 628 * @param menu the menu to add -
trunk/src/org/openstreetmap/josm/gui/MapFrame.java
r9243 r9246 648 648 /** 649 649 * Find panel on top of MapView by class 650 * @param <T> type 650 651 * @param type type of panel 651 652 * @return found panel -
trunk/src/org/openstreetmap/josm/gui/MapView.java
r9243 r9246 838 838 * List<WMSLayer> wmsLayers = getLayersOfType(WMSLayer.class); 839 839 * </pre> 840 * @param <T> layer type 840 841 * 841 842 * @param ofType The layer type. -
trunk/src/org/openstreetmap/josm/gui/dialogs/CommandStackDialog.java
r9243 r9246 197 197 /** 198 198 * Wires updater for enabled state to the events. Also updates dialog title if needed. 199 * @param updater updater 200 * @param tree tree on which wire updater 199 201 */ 200 202 protected void wireUpdateEnabledStateUpdater(final IEnabledStateUpdating updater, JTree tree) { -
trunk/src/org/openstreetmap/josm/gui/dialogs/LayerListDialog.java
r9224 r9246 160 160 /** 161 161 * Creates a layer list and attach it to the given mapView. 162 * @param mapFrame map frame 162 163 */ 163 164 protected LayerListDialog(MapFrame mapFrame) { … … 831 832 /** 832 833 * Constructs a new {@code MergeAction}. 834 * @param layer the layer (null if layer list if specified) 835 * @param layers the layer list (null if a single layer is specified) 833 836 */ 834 837 private MergeAction(Layer layer, List<Layer> layers) { -
trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberTableModel.java
r9195 r9246 64 64 /** 65 65 * constructor 66 * @param layer data layer 67 * @param presetHandler tagging preset handler 66 68 */ 67 69 public MemberTableModel(OsmDataLayer layer, TaggingPresetHandler presetHandler) { … … 73 75 } 74 76 77 /** 78 * Returns the data layer. 79 * @return the data layer 80 */ 75 81 public OsmDataLayer getLayer() { 76 82 return layer; … … 525 531 /** 526 532 * Replies the set of selected referers. Never null, but may be empty. 533 * @param referenceSet reference set 527 534 * 528 535 * @return the set of selected referers -
trunk/src/org/openstreetmap/josm/gui/dialogs/relation/RelationDialogManager.java
r9059 r9246 231 231 * upper left corner is close to <code>p</code>. 232 232 * 233 * @param p the reference point to check 233 * @param p the reference point to check 234 * @param thisEditor the current editor 234 235 * @return true, if there is another open {@link RelationEditor} whose 235 236 * upper left corner is close to <code>p</code>. -
trunk/src/org/openstreetmap/josm/gui/dialogs/relation/sort/RelationNodeMap.java
r9059 r9246 27 27 * 28 28 * @author Christiaan Welvaart <cjw@time4t.net> 29 * 29 * @since 1785 30 30 */ 31 31 public class RelationNodeMap { … … 173 173 174 174 /** 175 * Return a relation member that is linked to the 176 * member 'i', but has not been popped yet. 175 * Return a relation member that is linked to the member 'i', but has not been popped yet. 177 176 * Return null if there is no such member left. 177 * @param way way key 178 * @return a relation member that is linked to the member 'i', but has not been popped yet 178 179 */ 179 180 public Integer popAdjacent(Integer way) { … … 295 296 296 297 /** 297 * Returns some remaining member or null if 298 * every sortable member has been processed.298 * Returns some remaining member or null if every sortable member has been processed. 299 * @return member key 299 300 */ 300 301 public Integer pop() { … … 306 307 307 308 if (remainingOneway.isEmpty()) return null; 308 for (Integer i : remainingOneway.keySet()) { //find oneway, which is connected to more than one way (is between two oneway loops)309 for (Integer i : remainingOneway.keySet()) { //find oneway, which is connected to more than one way (is between two oneway loops) 309 310 for (Node n : onewayReverseMap.ways.get(i)) { 310 311 if (onewayReverseMap.nodes.containsKey(n) && onewayReverseMap.nodes.get(n).size() > 1) { … … 324 325 * This relation member has been processed. 325 326 * Remove references in the map.nodes. 327 * @param i member key 326 328 */ 327 329 private void doneOneway(Integer i) { -
trunk/src/org/openstreetmap/josm/gui/dialogs/relation/sort/RelationSortUtils.java
r8549 r9246 19 19 /** 20 20 * determine, if the way i is a roundabout and if yes, what type of roundabout 21 * @param member relation member 22 * @return roundabout type 21 23 */ 22 24 static Direction roundaboutType(RelationMember member) { 23 25 if (member == null || !member.isWay()) return NONE; 24 Way w = member.getWay(); 25 return roundaboutType(w); 26 return roundaboutType(member.getWay()); 26 27 } 27 28 -
trunk/src/org/openstreetmap/josm/gui/dialogs/relation/sort/WayConnectionTypeCalculator.java
r9087 r9246 22 22 /** 23 23 * refresh the cache of member WayConnectionTypes 24 * @param members relation members 25 * @return way connections 24 26 */ 25 27 public List<WayConnectionType> updateLinks(List<RelationMember> members) { … … 215 217 216 218 /** 217 * Determines the direction of way k with respect to the way ref_i. 218 * The way ref_i is assumed to have the direction ref_direction and 219 * to be the predecessor of k. 219 * Determines the direction of way {@code k} with respect to the way {@code ref_i}. 220 * The way {@code ref_i} is assumed to have the direction {@code ref_direction} and to be the predecessor of {@code k}. 220 221 * 221 222 * If both ways are not linked in any way, NONE is returned. … … 224 225 * Let the relation be a route of oneway streets, and someone travels them in the given order. 225 226 * Direction is FORWARD if it is legal and BACKWARD if it is illegal to do so for the given way. 226 * 227 **/ 227 * @param ref_i way key 228 * @param ref_direction direction of ref_i 229 * @param k successor of ref_i 230 * @param reversed if {@code true} determine reverse direction 231 * @return direction of way {@code k} 232 */ 228 233 private Direction determineDirection(int ref_i, final Direction ref_direction, int k, boolean reversed) { 229 234 if (ref_i < 0 || k < 0 || ref_i >= members.size() || k >= members.size()) -
trunk/src/org/openstreetmap/josm/gui/help/HelpContentReader.java
r9168 r9246 35 35 * 36 36 * @param helpTopicUrl the absolute help topic URL 37 * @param dotest 37 38 * @return the content, filtered and transformed for being displayed in the internal help browser 38 39 * @throws HelpContentReaderException if problem occurs … … 68 69 * 69 70 * @param in the input stream 71 * @param dotest if {@code true}, checks if help content is empty 72 * @param url help topic URL 70 73 * @return the content 71 74 * @throws HelpContentReaderException if an exception occurs -
trunk/src/org/openstreetmap/josm/gui/history/TwoColumnDiff.java
r9078 r9246 91 91 * The result from the diff algorithm is a "script" (a compressed description of the changes) 92 92 * This method expands this script into a full two column description. 93 * @param script diff script 94 * @param a reference version 95 * @param b current version 96 * @param reversed if {@code true} use {@link DiffItemType#REVERSED} instead of {@link DiffItemType#SAME} 93 97 */ 94 98 private void twoColumnDiffFromScript(Diff.Change script, Object[] a, Object[] b, final boolean reversed) { -
trunk/src/org/openstreetmap/josm/gui/io/AbstractUploadTask.java
r8540 r9246 53 53 * Synchronizes the local state of an {@link OsmPrimitive} with its state on the 54 54 * server. The method uses an individual GET for the primitive. 55 * 55 * @param type the primitive type 56 56 * @param id the primitive ID 57 57 */ … … 192 192 * Handles the case that a conflict was detected while uploading where we don't 193 193 * know what {@link OsmPrimitive} actually caused the conflict (for whatever reason) 194 * 194 * @param changesetId changeset ID 195 * @param d changeset date 195 196 */ 196 197 protected void handleUploadConflictForClosedChangeset(long changesetId, Date d) { … … 211 212 * Handles the case where deleting a node failed because it is still in use in 212 213 * a non-deleted way on the server. 214 * @param e exception 215 * @param conflict conflict 213 216 */ 214 217 protected void handleUploadPreconditionFailedConflict(OsmApiException e, Pair<OsmPrimitive, Collection<OsmPrimitive>> conflict) { -
trunk/src/org/openstreetmap/josm/gui/io/LayerNameAndFilePathTableCell.java
r8846 r9246 121 121 } 122 122 123 /** adds layer name label to (this) using the given info. Returns tooltip that 124 * should be added to the panel **/ 123 /** 124 * Adds layer name label to (this) using the given info. Returns tooltip that should be added to the panel 125 * @param info information, user preferences and save/upload states of the layer 126 * @return tooltip that should be added to the panel 127 */ 125 128 private String addLblLayerName(SaveLayerInfo info) { 126 129 lblLayerName.setIcon(info.getLayer().getIcon()); … … 130 133 } 131 134 132 /** adds filename label to (this) using the given info. Returns tooltip that 133 * should be added to the panel */ 135 /** 136 * Adds filename label to (this) using the given info. Returns tooltip that should be added to the panel 137 * @param info information, user preferences and save/upload states of the layer 138 * @return tooltip that should be added to the panel 139 */ 134 140 private String addLblFilename(SaveLayerInfo info) { 135 141 String tooltip = ""; … … 157 163 } 158 164 159 /** makes the given path fit lblFilename, appends ellipsis on the left if it doesn’t fit. 160 * Idea: /home/user/josm → …/user/josm → …/josm; and take the first one that fits */ 165 /** 166 * Makes the given path fit lblFilename, appends ellipsis on the left if it doesn’t fit. 167 * Idea: /home/user/josm → …/user/josm → …/josm; and take the first one that fits 168 * @param t complete path 169 * @return shorter path 170 */ 161 171 private String makePathFit(String t) { 162 172 boolean hasEllipsis = false; -
trunk/src/org/openstreetmap/josm/gui/io/TagSettingsPanel.java
r8846 r9246 80 80 } 81 81 82 /** 83 * Initialize panel from changeset. 84 * @param cs changeset 85 */ 82 86 public void initFromChangeset(Changeset cs) { 83 87 Map<String, String> tags = getDefaultTags(); … … 103 107 /** 104 108 * Replies the map with the current tags in the tag editor model. 105 * 109 * @param keepEmpty {@code true} to keep empty tags 106 110 * @return the map with the current tags in the tag editor model. 107 111 */ … … 110 114 } 111 115 116 /** 117 * Replies the map with the default tags. 118 * @return the map with the default tags 119 */ 112 120 public Map<String, String> getDefaultTags() { 113 121 Map<String, String> tags = new HashMap<>(); … … 116 124 } 117 125 126 /** 127 * Sets the map with the default tags. 128 * @param tags the map with the default tags 129 */ 118 130 public void setDefaultTags(Map<String, String> tags) { 119 131 defaultTags.clear(); -
trunk/src/org/openstreetmap/josm/gui/tagging/TagEditorModel.java
r9231 r9246 436 436 } 437 437 438 /** 439 * Returns tags, without empty ones. 440 * @return not-empty tags 441 */ 438 442 public Map<String, String> getTags() { 439 443 return getTags(false); 440 444 } 441 445 446 /** 447 * Returns tags. 448 * @param keepEmpty {@code true} to keep empty tags 449 * @return tags 450 */ 442 451 public Map<String, String> getTags(boolean keepEmpty) { 443 452 return applyToTags(keepEmpty); -
trunk/src/org/openstreetmap/josm/gui/util/GuiHelper.java
r9231 r9246 122 122 * <a href="http://docs.oracle.com/javase/tutorial/uiswing/concurrency/dispatch.html">Event Dispatch Thread</a> 123 123 * and return a value. 124 * @param <V> the result type of method <tt>call</tt> 124 125 * @param callable The callable to execute 125 126 * @return The computed result -
trunk/src/org/openstreetmap/josm/tools/Pair.java
r8846 r9246 69 69 /** 70 70 * Convenient constructor method 71 * @param <U> type of first item 72 * @param <V> type of second item 71 73 * @param u The first item 72 74 * @param v The second item -
trunk/src/org/openstreetmap/josm/tools/Predicates.java
r8928 r9246 18 18 /** 19 19 * Returns the negation of {@code predicate}. 20 * @param <T> type of items 20 21 * @param predicate the predicate to negate 21 22 * @return the negation of {@code predicate} … … 32 33 /** 33 34 * Returns a {@link Predicate} executing {@link Objects#equals}. 35 * @param <T> type of items 34 36 * @param ref the reference object 35 37 * @return a {@link Predicate} executing {@link Objects#equals} … … 117 119 /** 118 120 * Returns a {@link Predicate} executing {@link Collection#contains(Object)}. 121 * @param <T> type of items 119 122 * @param target collection 120 123 * @return a {@link Predicate} executing {@link Collection#contains(Object)} … … 131 134 /** 132 135 * Returns a {@link Predicate} testing whether objects are {@code null}. 136 * @param <T> type of items 133 137 * @return a {@link Predicate} testing whether objects are {@code null} 134 138 */ -
trunk/src/org/openstreetmap/josm/tools/Utils.java
r9231 r9246 95 95 /** 96 96 * Tests whether {@code predicate} applies to at least one element from {@code collection}. 97 * @param <T> type of items 97 98 * @param collection the collection 98 99 * @param predicate the predicate … … 109 110 /** 110 111 * Tests whether {@code predicate} applies to all elements from {@code collection}. 112 * @param <T> type of items 111 113 * @param collection the collection 112 114 * @param predicate the predicate … … 149 151 /** 150 152 * Returns the first element from {@code items} which is non-null, or null if all elements are null. 153 * @param <T> type of items 151 154 * @param items the items to look for 152 155 * @return first non-null item if there is one … … 165 168 * Filter a collection by (sub)class. 166 169 * This is an efficient read-only implementation. 170 * @param <S> Super type of items 171 * @param <T> type of items 167 172 * @param collection the collection 168 173 * @param klass the (sub)class … … 349 354 /** 350 355 * Copies the given array. Unlike {@link Arrays#copyOf}, this method is null-safe. 356 * @param <T> type of items 351 357 * @param array The array to copy 352 358 * @return A copy of the original array, or {@code null} if {@code array} is null … … 657 663 /** 658 664 * Topological sort. 665 * @param <T> type of items 659 666 * 660 667 * @param dependencies contains mappings (key -> value). In the final list of sorted objects, the key will come … … 1225 1232 /** 1226 1233 * Adds the given item at the end of a new copy of given array. 1234 * @param <T> type of items 1227 1235 * @param array The source array 1228 1236 * @param item The item to add
Note:
See TracChangeset
for help on using the changeset viewer.