Ignore:
Timestamp:
2015-06-06T04:32:00+02:00 (9 years ago)
Author:
Don-vip
Message:

javadoc fixes. Removed one duplicated method in exception handling

Location:
trunk/src/org/openstreetmap/josm/data
Files:
17 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/org/openstreetmap/josm/data/CustomConfigurator.java

    r8461 r8470  
    955955     * @param tmpPref - preferences to fill from JS
    956956     * @param varInJS - JS variable name, where preferences are stored
    957      * @throws ScriptException
     957     * @throws ScriptException if the evaluation fails
    958958     */
    959959    public static void readPrefsFromJS(ScriptEngine engine, Preferences tmpPref, String varInJS) throws ScriptException {
    … …  
    10401040     * @param whereToPutInJS - variable name to store preferences in JS
    10411041     * @param includeDefaults - include known default values to JS objects
    1042      * @throws ScriptException
     1042     * @throws ScriptException if the evaluation fails
    10431043     */
    10441044    public static void loadPrefsToJS(ScriptEngine engine, Preferences tmpPref, String whereToPutInJS, boolean includeDefaults) throws ScriptException {

  • trunk/src/org/openstreetmap/josm/data/cache/BufferedImageCacheEntry.java

    r8344 r8470  
    3434     *
    3535     * @return BufferedImage of cache entry content
    36      * @throws IOException
     36     * @throws IOException if an error occurs during reading.
    3737     */
    3838    public BufferedImage getImage() throws IOException {

  • trunk/src/org/openstreetmap/josm/data/cache/ICachedLoaderJob.java

    r8440 r8470  
    3737
    3838    /**
    39      * Submit job for background fetch, and listener will be
    40      * fed with value object
     39     * Submit job for background fetch, and listener will be fed with value object
    4140     *
    42      * @param listener
     41     * @param listener cache loader listener
    4342     * @param force true if the load should skip all the caches (local & remote)
    4443     */

  • trunk/src/org/openstreetmap/josm/data/cache/ICachedLoaderListener.java

    r8403 r8470  
    66    /**
    77     * Result of download
    8      *
    98     */
    109    enum LoadResult {
    … …  
    1312        CANCELED
    1413    }
     14
    1515    /**
    1616     * Will be called when K object processed. The result might be:
    … …  
    1919     * LoadResult.REJECTED when job was rejected because of full queue
    2020     *
    21      * @param data
    22      * @param attributes
    23      * @param result
     21     * @param data cache entry contents
     22     * @param attributes cache entry attributes
     23     * @param result load result (success, failure, canceled)
    2424     */
    2525    public void loadingFinished(CacheEntry data, CacheEntryAttributes attributes, LoadResult result);
    26 
    2726}

  • trunk/src/org/openstreetmap/josm/data/imagery/WmsCache.java

    r8384 r8470  
    504504     *
    505505     * @param img Used only when overlapping is used, when not used, used raw from imageData
    506      * @param imageData
    507      * @param projection
    508      * @param pixelPerDegree
    509      * @param east
    510      * @param north
    511      * @throws IOException
     506     * @param imageData input stream to raw image data
     507     * @param projection current projection
     508     * @param pixelPerDegree number of pixels per degree
     509     * @param east easting
     510     * @param north northing
     511     * @throws IOException if any I/O error occurs
    512512     */
    513     public synchronized void saveToCache(BufferedImage img, InputStream imageData, Projection projection, double pixelPerDegree, double east, double north) throws IOException {
     513    public synchronized void saveToCache(BufferedImage img, InputStream imageData, Projection projection, double pixelPerDegree, double east, double north)
     514            throws IOException {
    514515        ProjectionEntries projectionEntries = getProjectionEntries(projection);
    515516        CacheEntry entry = findEntry(projectionEntries, pixelPerDegree, east, north);
    … …  
    523524                mimeType = URLConnection.guessContentTypeFromStream(imageData);
    524525            }
    525             entry = new CacheEntry(pixelPerDegree, east, north, tileSize,generateFileName(projectionEntries, pixelPerDegree, projection, east, north, mimeType));
     526            entry = new CacheEntry(pixelPerDegree, east, north,
     527                    tileSize,generateFileName(projectionEntries, pixelPerDegree, projection, east, north, mimeType));
    526528            entry.lastUsed = System.currentTimeMillis();
    527529            entry.lastModified = entry.lastUsed;

  • trunk/src/org/openstreetmap/josm/data/osm/BBox.java

    r8393 r8470  
    3333     * Result is minimal BBox containing both points.
    3434     *
    35      * @param a
    36      * @param b
     35     * @param a first point
     36     * @param b second point
    3737     */
    3838    public BBox(LatLon a, LatLon b) {

  • trunk/src/org/openstreetmap/josm/data/osm/DataSet.java

    r8338 r8470  
    954954    /**
    955955     * Show message and stack trace in log in case primitive is not found
    956      * @param primitiveId
     956     * @param primitiveId primitive id to look for
    957957     * @return Primitive by id.
    958958     */

  • trunk/src/org/openstreetmap/josm/data/osm/OsmPrimitive.java

    r8444 r8470  
    4545    private static final String SPECIAL_VALUE_LOCAL_NAME = "localname";
    4646
    47 
    4847    /**
    4948     * An object can be disabled by the filter mechanism.
    … …  
    115114     * If <code>list</code> is null, replies an empty list.
    116115     *
    117      * @param <T>
     116     * @param <T> type of data (must be one of the {@link OsmPrimitive} types
    118117     * @param list  the original list
    119118     * @param type the type to filter for
    120119     * @return the sub-list of OSM primitives of type <code>type</code>
    121120     */
    122     public static <T extends OsmPrimitive>  List<T> getFilteredList(Collection<OsmPrimitive> list, Class<T> type) {
     121    public static <T extends OsmPrimitive> List<T> getFilteredList(Collection<OsmPrimitive> list, Class<T> type) {
    123122        if (list == null) return Collections.emptyList();
    124123        List<T> ret = new LinkedList<>();
    … …  
    249248     *
    250249     * @param id the id
    251      * @param allowNegativeId
     250     * @param allowNegativeId {@code true} to allow negative id
    252251     * @throws IllegalArgumentException if id &lt; 0 and allowNegativeId is false
    253252     */
    … …  
    278277     * If id is not &gt; 0 version is ignored and set to 0.
    279278     *
    280      * @param id
    281      * @param version
    282      * @param allowNegativeId
     279     * @param id the id
     280     * @param version the version (positive integer)
     281     * @param allowNegativeId {@code true} to allow negative id
    283282     * @throws IllegalArgumentException if id &lt; 0 and allowNegativeId is false
    284283     */
    … …  
    288287        setIncomplete(id > 0 && version == 0);
    289288    }
    290 
    291289
    292290    /*----------
    … …  
    313311    /**
    314312     * This method should never ever by called from somewhere else than Dataset.addPrimitive or removePrimitive methods
    315      * @param dataSet
     313     * @param dataSet the parent dataset
    316314     */
    317315    void setDataset(DataSet dataSet) {
    … …  
    11751173
    11761174    /**
    1177      * Replies true if this primitive and other are equal with respect to their
    1178      * semantic attributes.
     1175     * Replies true if this primitive and other are equal with respect to their semantic attributes.
    11791176     * <ol>
    11801177     *   <li>equal id</li>
    … …  
    11821179     *   <li>both have the same tags</li>
    11831180     * </ol>
    1184      * @param other
    1185      * @return true if this primitive and other are equal with respect to their
    1186      * semantic attributes.
     1181     * @param other other primitive to compare
     1182     * @return true if this primitive and other are equal with respect to their semantic attributes.
    11871183     */
    11881184    public boolean hasEqualSemanticAttributes(OsmPrimitive other) {
    … …  
    11971193
    11981194    /**
    1199      * Replies true if this primitive and other are equal with respect to their
    1200      * technical attributes. The attributes:
     1195     * Replies true if this primitive and other are equal with respect to their technical attributes.
     1196     * The attributes:
    12011197     * <ol>
    12021198     *   <li>deleted</li>
    … …  
    12091205     * have to be equal
    12101206     * @param other the other primitive
    1211      * @return true if this primitive and other are equal with respect to their
    1212      * technical attributes
     1207     * @return true if this primitive and other are equal with respect to their technical attributes
    12131208     */
    12141209    public boolean hasEqualTechnicalAttributes(OsmPrimitive other) {
    12151210        if (other == null) return false;
    12161211
    1217         return
    1218                 isDeleted() == other.isDeleted()
     1212        return  isDeleted() == other.isDeleted()
    12191213                && isModified() == other.isModified()
    12201214                && timestamp == other.timestamp

  • trunk/src/org/openstreetmap/josm/data/osm/Relation.java

    r8444 r8470  
    109109    /**
    110110     * Replace member at position specified by index.
    111      * @param index
    112      * @param member
     111     * @param index index (positive integer)
     112     * @param member relation member to set
    113113     * @return Member that was at the position
    114114     */
    … …  
    133133    /**
    134134     * Removes member at specified position.
    135      * @param index
     135     * @param index index (positive integer)
    136136     * @return Member that was at the position
    137137     */
    … …  
    218218    /**
    219219     * Creates new relation
    220      * @param id
    221      * @param version
     220     * @param id the id
     221     * @param version version number (positive integer)
    222222     */
    223223    public Relation(long id, int version) {

  • trunk/src/org/openstreetmap/josm/data/osm/Storage.java

    r8384 r8470  
    130130    /**
    131131     * constructor
    132      * @param ha
    133      * @param capacity
     132     * @param ha hash
     133     * @param capacity capacity
    134134     * @param safeIterator If set to false, you must not modify the Storage
    135135     *          while iterating over it. If set to true, you can safely

  • trunk/src/org/openstreetmap/josm/data/osm/User.java

    r8444 r8470  
    148148     * Adds a user name to the list if it is not there, yet.
    149149     *
    150      * @param name
     150     * @param name User name
    151151     */
    152152    public void addName(String name) {
    … …  
    157157     * Returns true if the name is in the names list
    158158     *
    159      * @param name
     159     * @param name User name
    160160     * @return <code>true</code> if the name is in the names list
    161161     */

  • trunk/src/org/openstreetmap/josm/data/osm/visitor/BoundingXYVisitor.java

    r8395 r8470  
    107107     * equal <code>null</code>) this method does not do anything.
    108108     *
    109      * @param enlargeDegree
     109     * @param enlargeDegree number of degrees to enlarge on each side
    110110     */
    111111    public void enlargeBoundingBox(double enlargeDegree) {
    … …  
    141141     * equal <code>null</code>) this method does not do anything.
    142142     *
    143      * @param maxEnlargePercent
     143     * @param maxEnlargePercent maximum enlargement in percentage (100.0 for 100%)
    144144     */
    145145    public void enlargeBoundingBoxLogarithmically(double maxEnlargePercent) {

  • trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/StyledMapRenderer.java

    r8444 r8470  
    857857     * highlights a given GeneralPath using the settings from BasicStroke to match the line's
    858858     * style. Width of the highlight is hard coded.
    859      * @param path
    860      * @param line
     859     * @param path path to draw
     860     * @param line line style
    861861     */
    862862    private void drawPathHighlight(GeneralPath path, BasicStroke line) {

  • trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2GridShiftFile.java

    r8415 r8470  
    9999     * @param in Grid Shift File InputStream
    100100     * @param loadAccuracy is Accuracy data to be loaded as well as shift data?
    101      * @throws IOException
     101     * @throws IOException if any I/O error occurs
    102102     */
    103103    public void loadGridShiftFile(InputStream in, boolean loadAccuracy) throws IOException {

  • trunk/src/org/openstreetmap/josm/data/projection/datum/NTV2SubGrid.java

    r8406 r8470  
    6969     * @param bigEndian is the file bigEndian?
    7070     * @param loadAccuracy is the node Accuracy data to be loaded?
    71      * @throws IOException
     71     * @throws IOException if any I/O error occurs
    7272     */
    7373    public NTV2SubGrid(InputStream in, boolean bigEndian, boolean loadAccuracy) throws IOException {
    … …  
    283283    /**
    284284     * Set an array of Sub Grids of this sub grid
    285      * @param subGrid
     285     * @param subGrid subgrids
    286286     */
    287287    public void setSubGridArray(NTV2SubGrid[] subGrid) {

  • trunk/src/org/openstreetmap/josm/data/validation/Test.java

    r8378 r8470  
    251251     * Fixes the error with the appropriate command
    252252     *
    253      * @param testError
     253     * @param testError error to fix
    254254     * @return The command to fix the error
    255255     */

  • trunk/src/org/openstreetmap/josm/data/validation/tests/TagChecker.java

    r8461 r8470  
    99import java.awt.event.ActionListener;
    1010import java.io.BufferedReader;
    11 import java.io.FileNotFoundException;
    1211import java.io.IOException;
    1312import java.io.InputStream;
    … …  
    154153     * by the nearest + word before this.
    155154     *
    156      * @throws FileNotFoundException
    157      * @throws IOException
     155     * @throws IOException if any I/O error occurs
    158156     */
    159157    private static void initializeData() throws IOException {
Note: See TracChangeset for help on using the changeset viewer.