Ignore:
Timestamp:
2015-10-22T02:01:00+02:00 (4 years ago)
Author:
Don-vip
Message:

javadoc fixes

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

Legend:

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

    r8846 r8926  
    128128    /**
    129129     * Parse the given input source and return the dataset.
     130     * @throws IllegalDataException if an error was found while parsing the OSM data
    130131     *
    131132     * @see OsmReader#parseDataSet(InputStream, ProgressMonitor)
  • trunk/src/org/openstreetmap/josm/io/CacheCustomContent.java

    r8840 r8926  
    6060     * executed in the current thread.
    6161     * @return the data to cache
     62     * @throws T a {@link Throwable}
    6263     */
    6364    protected abstract byte[] updateData() throws T;
     
    175176    /**
    176177     * Tries to load the data using the given ident from disk. If this fails, data will be updated, unless run in offline mode
     178     * @throws T a {@link Throwable}
    177179     */
    178180    private void loadFromDisk() throws T {
  • trunk/src/org/openstreetmap/josm/io/OsmApi.java

    r8846 r8926  
    877877    }
    878878
    879     /** Method for parsing API responses for operations on individual notes */
     879    /**
     880     * Method for parsing API responses for operations on individual notes
     881     * @param xml the API response as XML data
     882     * @return the resulting Note
     883     * @throws OsmTransferException if the API response cannot be parsed
     884     */
    880885    private Note parseSingleNote(String xml) throws OsmTransferException {
    881886        try {
  • trunk/src/org/openstreetmap/josm/io/OsmImporter.java

    r8855 r8926  
    8484     * @param associatedFile filename of data (layer name will be generated from name of file)
    8585     * @param pm handler for progress monitoring and canceling
     86     * @throws IllegalDataException if an error was found while parsing the OSM data
    8687     */
    8788    protected void importData(InputStream in, final File associatedFile, ProgressMonitor pm) throws IllegalDataException {
     
    112113     * @param layerName name of generated layer
    113114     * @param progressMonitor handler for progress monitoring and canceling
     115     * @throws IllegalDataException if an error was found while parsing the OSM data
    114116     */
    115117    public OsmImporterData loadLayer(InputStream in, final File associatedFile, final String layerName, ProgressMonitor progressMonitor)
  • trunk/src/org/openstreetmap/josm/io/OsmReader.java

    r8846 r8926  
    398398     * This is basically the same code as parseUnknown(), except for the warnings, which
    399399     * are displayed for inner elements and not at top level.
     400     * @throws XMLStreamException if there is an error processing the underlying XML source
    400401     */
    401402    private void jumpToEnd(boolean printWarning) throws XMLStreamException {
     
    430431    /**
    431432     * Read out the common attributes and put them into current OsmPrimitive.
     433     * @throws XMLStreamException if there is an error processing the underlying XML source
    432434     */
    433435    private void readCommon(PrimitiveData current) throws XMLStreamException {
  • trunk/src/org/openstreetmap/josm/io/UTFInputStreamReader.java

    r8510 r8926  
    1616     * Creates a new {@link InputStreamReader} from the {@link InputStream} with UTF-8 as default encoding.
    1717     * @return A reader with the correct encoding. Starts to read after the BOM.
     18     * @throws IOException if any I/O error occurs
    1819     * @see #create(java.io.InputStream, String)
    1920     */
     
    2627     * @param defaultEncoding Used, when no BOM was recognized. Can be null.
    2728     * @return A reader with the correct encoding. Starts to read after the BOM.
     29     * @throws IOException if any I/O error occurs
    2830     */
    2931    public static UTFInputStreamReader create(InputStream input, String defaultEncoding) throws IOException {
  • trunk/src/org/openstreetmap/josm/io/remotecontrol/RemoteControlHttpsServer.java

    r8840 r8926  
    134134     * @param algorithm the signing algorithm, eg "SHA256withRSA"
    135135     * @param san SubjectAlternativeName extension (optional)
     136     * @return the self-signed X.509 Certificate
     137     * @throws GeneralSecurityException if any security error occurs
     138     * @throws IOException if any I/O error occurs
    136139     */
    137140    private static X509Certificate generateCertificate(String dn, KeyPair pair, int days, String algorithm, String san)
    138141            throws GeneralSecurityException, IOException {
    139         PrivateKey privkey = pair.getPrivate();
    140142        X509CertInfo info = new X509CertInfo();
    141143        Date from = new Date();
     
    193195
    194196        // Sign the cert to identify the algorithm that's used.
     197        PrivateKey privkey = pair.getPrivate();
    195198        X509CertImpl cert = new X509CertImpl(info);
    196199        cert.sign(privkey, algorithm);
  • trunk/src/org/openstreetmap/josm/io/session/SessionLayerExporter.java

    r5391 r8926  
    66import java.util.Collection;
    77
    8 import org.w3c.dom.Element;
    9 
    108import org.openstreetmap.josm.gui.layer.Layer;
    119import org.openstreetmap.josm.io.session.SessionWriter.ExportSupport;
     10import org.w3c.dom.Element;
    1211
    1312public interface SessionLayerExporter {
     
    1514    /**
    1615     * Return the Layers, this Layer depends on.
     16     * @return the layer dependencies
    1717     */
    1818    Collection<Layer> getDependencies();
     
    2020    /**
    2121     * The GUI for exporting this layer.
     22     * @return the export panel
    2223     */
    2324    Component getExportPanel();
    2425
    2526    /**
    26      * Return true, if the layer should be included in the
    27      * list of exported layers.
     27     * Return true, if the layer should be included in the list of exported layers.
    2828     *
    2929     * The user can veto this in the export panel.
     30     * @return {@code true} if the layer should be included in the list of exported layers, {@code false} otherwise.
    3031     */
    3132    boolean shallExport();
    3233
    3334    /**
    34      * Return true, if some data needs to be included in
    35      * the zip archive. This decision depends on the user
     35     * Return true, if some data needs to be included in the zip archive. This decision depends on the user
    3636     * selection in the export panel.
    3737     *
    38      * If any layer requires zip, the user can only save as
    39      * .joz. Otherwise both .jos and .joz are possible.
     38     * If any layer requires zip, the user can only save as .joz. Otherwise both .jos and .joz are possible.
     39     * @return {@code true} if some data needs to be included in the zip archive, {@code false} otherwise.
    4040     */
    4141    boolean requiresZip();
     
    4444     * Save meta data to the .jos file. Return a layer XML element.
    4545     * Use <code>support</code> to save files in the zip archive as needed.
     46     * @param support support class providing export utilities
     47     * @return the resulting XML element
     48     * @throws IOException  if any I/O error occurs
    4649     */
    4750    Element export(ExportSupport support) throws IOException;
    48 
    4951}
    50 
  • trunk/src/org/openstreetmap/josm/io/session/SessionLayerImporter.java

    r4668 r8926  
    44import java.io.IOException;
    55
    6 import org.w3c.dom.Element;
    7 
    86import org.openstreetmap.josm.gui.layer.Layer;
    97import org.openstreetmap.josm.gui.progress.ProgressMonitor;
    108import org.openstreetmap.josm.io.IllegalDataException;
    119import org.openstreetmap.josm.io.session.SessionReader.ImportSupport;
     10import org.w3c.dom.Element;
    1211
    1312public interface SessionLayerImporter {
     13
    1414    /**
    1515     * Load the layer from xml meta-data.
     16     * @param elem XML element
     17     * @param support support class providing import utilities
     18     * @param progressMonitor progress monitor
     19     * @return the resulting layer
     20     * @throws IOException if any I/O error occurs
     21     * @throws IllegalDataException if invalid data is read
    1622     */
    1723    Layer load(Element elem, ImportSupport support, ProgressMonitor progressMonitor) throws IOException, IllegalDataException;
  • trunk/src/org/openstreetmap/josm/io/session/SessionReader.java

    r8850 r8926  
    196196         * Returns null if the URI points to a file inside the zip archive.
    197197         * In this case, inZipPath will be set to the corresponding path.
     198         * @param uriStr the URI as string
     199         * @return the resulting File
     200         * @throws IOException if any I/O error occurs
    198201         */
    199202        public File getFile(String uriStr) throws IOException {
  • trunk/src/org/openstreetmap/josm/io/session/SessionWriter.java

    r8836 r8926  
    142142         * @return the OutputStream you can write to. Never close the returned
    143143         * output stream, but make sure to flush buffers.
     144         * @throws IOException if any I/O error occurs
    144145         */
    145146        public OutputStream getOutputStreamZip(String zipPath) throws IOException {
Note: See TracChangeset for help on using the changeset viewer.