Index: trunk/src/org/openstreetmap/josm/gui/io/BasicUploadSettingsPanel.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/io/BasicUploadSettingsPanel.java (revision 12369) +++ trunk/src/org/openstreetmap/josm/gui/io/BasicUploadSettingsPanel.java (revision 12370) @@ -39,7 +39,19 @@ */ public class BasicUploadSettingsPanel extends JPanel { + /** + * Preference name for history collection + */ public static final String HISTORY_KEY = "upload.comment.history"; + /** + * Preference name for last used upload comment + */ public static final String HISTORY_LAST_USED_KEY = "upload.comment.last-used"; + /** + * Preference name for the max age search comments may have + */ public static final String HISTORY_MAX_AGE_KEY = "upload.comment.max-age"; + /** + * Preference name for the history of source values + */ public static final String SOURCE_HISTORY_KEY = "upload.source.history"; Index: trunk/src/org/openstreetmap/josm/gui/io/MaxChangesetSizeExceededPolicy.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/io/MaxChangesetSizeExceededPolicy.java (revision 12369) +++ trunk/src/org/openstreetmap/josm/gui/io/MaxChangesetSizeExceededPolicy.java (revision 12370) @@ -2,4 +2,7 @@ package org.openstreetmap.josm.gui.io; +/** + * This determines what to do when the max changeset size was exceeded by a upload. + */ public enum MaxChangesetSizeExceededPolicy { /** Index: trunk/src/org/openstreetmap/josm/gui/io/UploadOrSaveState.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/io/UploadOrSaveState.java (revision 12369) +++ trunk/src/org/openstreetmap/josm/gui/io/UploadOrSaveState.java (revision 12370) @@ -2,4 +2,7 @@ package org.openstreetmap.josm.gui.io; +/** + * The state a layer may have after attempting to upload it + */ public enum UploadOrSaveState { /** Index: trunk/src/org/openstreetmap/josm/gui/io/UploadParameterSummaryPanel.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/io/UploadParameterSummaryPanel.java (revision 12369) +++ trunk/src/org/openstreetmap/josm/gui/io/UploadParameterSummaryPanel.java (revision 12370) @@ -22,5 +22,9 @@ import org.openstreetmap.josm.tools.ImageProvider; -// FIXME this class should extend HtmlPanel instead (duplicated code in here) +/** + * A panel that displays a summary of data the user is about to upload + *

+ * FIXME this class should extend HtmlPanel instead (duplicated code in here) + */ public class UploadParameterSummaryPanel extends JPanel implements HyperlinkListener, PropertyChangeListener { private transient UploadStrategySpecification spec = new UploadStrategySpecification(); @@ -129,4 +133,8 @@ } + /** + * Sets the {@link UploadStrategySpecification} the user chose + * @param spec The specification to display + */ public void setUploadStrategySpecification(UploadStrategySpecification spec) { this.spec = spec; @@ -134,4 +142,8 @@ } + /** + * Sets the number of objects that will be uploaded + * @param numObjects The number to display + */ public void setNumObjects(int numObjects) { this.numObjects = numObjects; @@ -139,4 +151,8 @@ } + /** + * Display that the changeset will be closed after the upload + * @param value true if it will be closed + */ public void setCloseChangesetAfterNextUpload(boolean value) { this.closeChangesetAfterNextUpload = value; Index: trunk/src/org/openstreetmap/josm/gui/io/UploadSelectionDialog.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/io/UploadSelectionDialog.java (revision 12369) +++ trunk/src/org/openstreetmap/josm/gui/io/UploadSelectionDialog.java (revision 12370) @@ -145,4 +145,8 @@ } + /** + * See if the user pressed the cancel button + * @return true if the user canceled the upload + */ public boolean isCanceled() { return canceled; @@ -153,4 +157,8 @@ } + /** + * Gets the list of primitives the user selected + * @return The primitives + */ public List getSelectedPrimitives() { List ret = new ArrayList<>(); Index: trunk/src/org/openstreetmap/josm/gui/io/UploadStrategy.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/io/UploadStrategy.java (revision 12369) +++ trunk/src/org/openstreetmap/josm/gui/io/UploadStrategy.java (revision 12370) @@ -8,4 +8,7 @@ import org.openstreetmap.josm.Main; +/** + * The chunk mode to use when uploading + */ public enum UploadStrategy { /** @@ -28,4 +31,9 @@ } + /** + * Reads the value from preferences + * @param preferenceValue The preference value + * @return The {@link UploadStrategy} for that preference or null if unknown + */ public static UploadStrategy fromPreference(String preferenceValue) { if (preferenceValue == null) return null; Index: trunk/src/org/openstreetmap/josm/gui/io/UploadStrategySelectionPanel.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/io/UploadStrategySelectionPanel.java (revision 12369) +++ trunk/src/org/openstreetmap/josm/gui/io/UploadStrategySelectionPanel.java (revision 12370) @@ -234,4 +234,8 @@ } + /** + * Sets the number of uploaded objects to display + * @param numUploadedObjects The number of objects + */ public void setNumUploadedObjects(int numUploadedObjects) { this.numUploadedObjects = Math.max(numUploadedObjects, 0); @@ -239,4 +243,8 @@ } + /** + * Fills the inputs using a {@link UploadStrategySpecification} + * @param strategy The strategy + */ public void setUploadStrategySpecification(UploadStrategySpecification strategy) { if (strategy == null) @@ -253,4 +261,8 @@ } + /** + * Gets the upload strategy the user chose + * @return The strategy + */ public UploadStrategySpecification getUploadStrategySpecification() { UploadStrategy strategy = getUploadStrategy(); @@ -301,4 +313,7 @@ } + /** + * Load the panel contents from preferences + */ public void initFromPreferences() { UploadStrategy strategy = UploadStrategy.getFromPreferences(); @@ -309,4 +324,7 @@ } + /** + * Stores the values that the user has input into the preferences + */ public void rememberUserInput() { UploadStrategy strategy = getUploadStrategy(); @@ -376,4 +394,7 @@ } + /** + * Sets the focus on the chunk size field + */ public void initEditingOfChunkSize() { tfChunkSize.requestFocusInWindow(); Index: trunk/src/org/openstreetmap/josm/gui/io/UploadStrategySpecification.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/io/UploadStrategySpecification.java (revision 12369) +++ trunk/src/org/openstreetmap/josm/gui/io/UploadStrategySpecification.java (revision 12370) @@ -56,16 +56,33 @@ } + /** + * Gets the chunk size + * @return The max size of each upload chunk + */ public int getChunkSize() { return chunkSize; } + /** + * Gets a special value that is used to indicate that the chunk size was not specified + * @return A special integer + */ public static int getUnspecifiedChunkSize() { return UNSPECIFIED_CHUNK_SIZE; } + /** + * Gets the policy that is used when the server max changeset size is exceeded. + * @return What to do when the changeset size is exceeded + */ public MaxChangesetSizeExceededPolicy getPolicy() { return policy; } + /** + * Sets the upload strategy (chunk mode) + * @param strategy The upload strategy + * @return This object, for easy chaining + */ public UploadStrategySpecification setStrategy(UploadStrategy strategy) { this.strategy = strategy; @@ -73,4 +90,9 @@ } + /** + * Sets the upload chunk size + * @param chunkSize The chunk size + * @return This object, for easy chaining + */ public UploadStrategySpecification setChunkSize(int chunkSize) { this.chunkSize = chunkSize; @@ -78,4 +100,9 @@ } + /** + * Sets the policy to use when the max changeset size is exceeded + * @param policy The policy + * @return This object, for easy chaining + */ public UploadStrategySpecification setPolicy(MaxChangesetSizeExceededPolicy policy) { this.policy = policy; @@ -83,4 +110,9 @@ } + /** + * Sets whether to close the changeset after this upload + * @param closeChangesetAfterUpload true to close it + * @return This object, for easy chaining + */ public UploadStrategySpecification setCloseChangesetAfterUpload(boolean closeChangesetAfterUpload) { this.closeChangesetAfterUpload = closeChangesetAfterUpload; @@ -88,8 +120,17 @@ } + /** + * Gets if the changeset should be closed after this upload + * @return true to close it + */ public boolean isCloseChangesetAfterUpload() { return closeChangesetAfterUpload; } + /** + * Gets the number of requests that will be required to upload the objects + * @param numObjects The number of objects + * @return The number of requests + */ public int getNumRequests(int numObjects) { if (numObjects <= 0) Index: trunk/src/org/openstreetmap/josm/gui/io/UploadedObjectsSummaryPanel.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/io/UploadedObjectsSummaryPanel.java (revision 12369) +++ trunk/src/org/openstreetmap/josm/gui/io/UploadedObjectsSummaryPanel.java (revision 12370) @@ -25,4 +25,7 @@ */ public class UploadedObjectsSummaryPanel extends JPanel { + /** + * The swing property name for the number of objects to upload + */ public static final String NUM_OBJECTS_TO_UPLOAD_PROP = UploadedObjectsSummaryPanel.class.getName() + ".numObjectsToUpload";