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

javadoc fixes. Removed one duplicated method in exception handling

Location:
trunk/src/org/openstreetmap/josm/io
Files:
13 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/io/CachedFile.java

    r8443 r8470  
    136136    /**
    137137     * Set the caching strategy. Only applies to URLs.
    138      * @param cachingStrategy
     138     * @param cachingStrategy caching strategy
    139139     * @return this object
    140140     */
  • trunk/src/org/openstreetmap/josm/io/Compression.java

    r7937 r8470  
    5555     * Returns an un-compressing {@link InputStream} for {@code in}.
    5656     *
    57      * @throws IOException
     57     * @throws IOException if any I/O error occurs
    5858     */
    5959    public InputStream getUncompressedInputStream(InputStream in) throws IOException {
     
    7474     * Returns an un-compressing {@link InputStream} for the {@link File} {@code file}.
    7575     *
    76      * @throws IOException
     76     * @throws IOException if any I/O error occurs
    7777     */
    7878    @SuppressWarnings("resource")
     
    8484     * Returns an un-compressing {@link InputStream} for the {@link URL} {@code url}.
    8585     *
    86      * @throws IOException
     86     * @throws IOException if any I/O error occurs
    8787     */
    8888    public static InputStream getUncompressedURLInputStream(URL url) throws IOException {
     
    9393     * Returns a compressing {@link OutputStream} for {@code out}.
    9494     *
    95      * @throws IOException
     95     * @throws IOException if any I/O error occurs
    9696     */
    9797    public OutputStream getCompressedOutputStream(OutputStream out) throws IOException {
     
    112112     * Returns a compressing {@link OutputStream} for the {@link File} {@code file}.
    113113     *
    114      * @throws IOException
     114     * @throws IOException if any I/O error occurs
    115115     */
    116116    @SuppressWarnings("resource")
  • trunk/src/org/openstreetmap/josm/io/GpxReader.java

    r8461 r8470  
    534534     * @return true if file was properly parsed, false if there was error during
    535535     * parsing but some data were parsed anyway
    536      * @throws SAXException
    537      * @throws IOException
     536     * @throws SAXException if any SAX parsing error occurs
     537     * @throws IOException if any I/O error occurs
    538538     */
    539539    public boolean parse(boolean tryToFinish) throws SAXException, IOException {
  • trunk/src/org/openstreetmap/josm/io/NoteReader.java

    r8377 r8470  
    197197     * Initializes the reader with a given InputStream
    198198     * @param source - InputStream containing Notes XML
    199      * @throws IOException
     199     * @throws IOException if any I/O error occurs
    200200     */
    201201    public NoteReader(InputStream source) throws IOException {
     
    206206     * Initializes the reader with a string as a source
    207207     * @param source UTF-8 string containing Notes XML to parse
    208      * @throws IOException
     208     * @throws IOException if any I/O error occurs
    209209     */
    210210    public NoteReader(String source) throws IOException {
     
    216216     * the resulting Note objects
    217217     * @return List of Notes parsed from the input data
    218      * @throws SAXException
    219      * @throws IOException
     218     * @throws SAXException if any SAX parsing error occurs
     219     * @throws IOException if any I/O error occurs
    220220     */
    221221    public List<Note> parse() throws SAXException, IOException {
  • trunk/src/org/openstreetmap/josm/io/OsmApi.java

    r8415 r8470  
    802802     * @param monitor Progress monitor
    803803     * @return Note as it exists on the server after creation (ID assigned)
    804      * @throws OsmTransferException
     804     * @throws OsmTransferException if any error occurs during dialog with OSM API
    805805     */
    806806    public Note createNote(LatLon latlon, String text, ProgressMonitor monitor) throws OsmTransferException {
     
    824824     * @param monitor Progress monitor
    825825     * @return Note returned by the API after the comment was added
    826      * @throws OsmTransferException
     826     * @throws OsmTransferException if any error occurs during dialog with OSM API
    827827     */
    828828    public Note addCommentToNote(Note note, String comment, ProgressMonitor monitor) throws OsmTransferException {
     
    842842     * @param monitor Progress monitor
    843843     * @return Note returned by the API after the close operation
    844      * @throws OsmTransferException
     844     * @throws OsmTransferException if any error occurs during dialog with OSM API
    845845     */
    846846    public Note closeNote(Note note, String closeMessage, ProgressMonitor monitor) throws OsmTransferException {
     
    864864     * @param monitor Progress monitor
    865865     * @return Note returned by the API after the reopen operation
    866      * @throws OsmTransferException
     866     * @throws OsmTransferException if any error occurs during dialog with OSM API
    867867     */
    868868    public Note reopenNote(Note note, String reactivateMessage, ProgressMonitor monitor) throws OsmTransferException {
  • trunk/src/org/openstreetmap/josm/io/OsmServerBackreferenceReader.java

    r8390 r8470  
    149149     *
    150150     * @return the data set
    151      * @throws OsmTransferException
     151     * @throws OsmTransferException if any error occurs during dialog with OSM API
    152152     */
    153153    protected DataSet getReferringWays(ProgressMonitor progressMonitor) throws OsmTransferException {
     
    160160     * @param progressMonitor the progress monitor
    161161     * @return the data set
    162      * @throws OsmTransferException
     162     * @throws OsmTransferException if any error occurs during dialog with OSM API
    163163     */
    164164    protected DataSet getReferringRelations(ProgressMonitor progressMonitor) throws OsmTransferException {
  • trunk/src/org/openstreetmap/josm/io/OsmServerObjectReader.java

    r8443 r8470  
    106106     * @param progressMonitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
    107107     * @return the downloaded data
    108      * @throws OsmTransferException
     108     * @throws OsmTransferException if any error occurs during dialog with OSM API
    109109     */
    110110    @Override
  • trunk/src/org/openstreetmap/josm/io/OsmServerReader.java

    r8415 r8470  
    366366     * Downloads notes from a given raw URL. The URL is assumed to be complete and no API limits are added
    367367     *
    368      * @param progressMonitor
     368     * @param progressMonitor progress monitor
    369369     * @return A list of notes parsed from the URL
    370      * @throws OsmTransferException
     370     * @throws OsmTransferException if any error occurs during dialog with OSM API
    371371     */
    372372    public List<Note> parseRawNotes(final ProgressMonitor progressMonitor) throws OsmTransferException {
     
    376376    /**
    377377     * Download notes from a URL that contains a bzip2 compressed notes dump file
    378      * @param progressMonitor
     378     * @param progressMonitor progress monitor
    379379     * @return A list of notes parsed from the URL
    380      * @throws OsmTransferException
     380     * @throws OsmTransferException if any error occurs during dialog with OSM API
    381381     */
    382382    public List<Note> parseRawNotesBzip2(final ProgressMonitor progressMonitor) throws OsmTransferException {
  • trunk/src/org/openstreetmap/josm/io/ProgressInputStream.java

    r8394 r8470  
    7878    /**
    7979     * Increase ticker (progress counter and displayed text) by the given amount.
    80      * @param amount
     80     * @param amount number of ticks
    8181     */
    8282    private void advanceTicker(int amount) {
  • trunk/src/org/openstreetmap/josm/io/remotecontrol/RemoteControlHttpServer.java

    r8342 r8470  
    113113     * Stops the HTTP server
    114114     *
    115      * @throws IOException
     115     * @throws IOException if any I/O error occurs
    116116     */
    117117    public void stopServer() throws IOException {
  • trunk/src/org/openstreetmap/josm/io/remotecontrol/RemoteControlHttpsServer.java

    r8404 r8470  
    114114     * @param v value
    115115     * @return which one
    116      * @throws IOException
     116     * @throws IOException if any I/O error occurs
    117117     */
    118118    private static GeneralName createGeneralName(String t, String v) throws IOException {
  • trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/AddNodeHandler.java

    r8464 r8470  
    7676    /**
    7777     * Adds a node, implements the GET /add_node?lon=...&amp;lat=... request.
    78      * @param args
     78     * @param args request arguments
    7979     */
    8080    private void addNode(Map<String, String> args){
  • trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/RequestHandler.java

    r8415 r8470  
    5757     * Check permission and parameters and handle request.
    5858     *
    59      * @throws RequestHandlerForbiddenException
    60      * @throws RequestHandlerBadRequestException
    61      * @throws RequestHandlerErrorException
     59     * @throws RequestHandlerForbiddenException if request is forbidden by preferences
     60     * @throws RequestHandlerBadRequestException if request is invalid
     61     * @throws RequestHandlerErrorException if an error occurs while processing request
    6262     */
    6363    public final void handle() throws RequestHandlerForbiddenException, RequestHandlerBadRequestException, RequestHandlerErrorException {
     
    7070    /**
    7171     * Validates the request before attempting to perform it.
    72      * @throws RequestHandlerBadRequestException
     72     * @throws RequestHandlerBadRequestException if request is invalid
    7373     * @since 5678
    7474     */
     
    8080     * This method of the subclass will do the real work.
    8181     *
    82      * @throws RequestHandlerErrorException
    83      * @throws RequestHandlerBadRequestException
     82     * @throws RequestHandlerErrorException if an error occurs while processing request
     83     * @throws RequestHandlerBadRequestException if request is invalid
    8484     */
    8585    protected abstract void handleRequest() throws RequestHandlerErrorException, RequestHandlerBadRequestException;
     
    133133
    134134    /**
    135      * Check permissions in preferences and display error message
    136      * or ask for permission.
    137      *
    138      * @throws RequestHandlerForbiddenException
     135     * Check permissions in preferences and display error message or ask for permission.
     136     *
     137     * @throws RequestHandlerForbiddenException if request is forbidden by preferences
    139138     */
    140139    public final void checkPermission() throws RequestHandlerForbiddenException {
Note: See TracChangeset for help on using the changeset viewer.