Index: trunk/src/org/openstreetmap/josm/data/osm/event/AbstractDatasetChangedEvent.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/AbstractDatasetChangedEvent.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/AbstractDatasetChangedEvent.java (revision 11928) @@ -7,6 +7,13 @@ import org.openstreetmap.josm.data.osm.OsmPrimitive; +/** + * Base class of all dataset change events. + * @since 2622 + */ public abstract class AbstractDatasetChangedEvent { + /** + * Type of dataset changed event, returned by {@link AbstractDatasetChangedEvent#getType}. + */ public enum DatasetEventType { DATA_CHANGED, @@ -21,10 +28,21 @@ } + /** + * The dataset from which the event came from. + */ protected final DataSet dataSet; + /** + * Constructs a new {@code AbstractDatasetChangedEvent}. + * @param dataSet the dataset from which the event came from + */ protected AbstractDatasetChangedEvent(DataSet dataSet) { this.dataSet = dataSet; } + /** + * Calls the appropriate method of the listener for this event. + * @param listener dataset listener to notify about this event + */ public abstract void fire(DataSetListener listener); @@ -40,8 +58,16 @@ public abstract Collection getPrimitives(); + /** + * Returns the dataset from which the event came from. + * @return the dataset from which the event came from + */ public DataSet getDataset() { return dataSet; } + /** + * Returns the type of dataset changed event. + * @return the type of dataset changed event + */ public abstract DatasetEventType getType(); Index: trunk/src/org/openstreetmap/josm/data/osm/event/ChangesetIdChangedEvent.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/ChangesetIdChangedEvent.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/ChangesetIdChangedEvent.java (revision 11928) @@ -13,4 +13,11 @@ private final int newChangesetId; + /** + * Constructs a new {@code ChangesetIdChangedEvent}. + * @param dataSet the dataset from which the event comes from + * @param primitives list of affected primitives + * @param oldChangesetId old changeset id + * @param newChangesetId new changeset id + */ public ChangesetIdChangedEvent(DataSet dataSet, List primitives, int oldChangesetId, int newChangesetId) { super(dataSet); @@ -35,8 +42,16 @@ } + /** + * Returns the old changeset id. + * @return the old changeset id + */ public int getOldChangesetId() { return oldChangesetId; } + /** + * Returns the new changeset id. + * @return the new changeset id + */ public int getNewChangesetId() { return newChangesetId; Index: trunk/src/org/openstreetmap/josm/data/osm/event/DataChangedEvent.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/DataChangedEvent.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/DataChangedEvent.java (revision 11928) @@ -15,5 +15,5 @@ /** * Constructs a new {@code DataChangedEvent} - * @param dataSet data set + * @param dataSet the dataset from which the event comes from * @param events list of change events */ @@ -25,5 +25,5 @@ /** * Constructs a new {@code DataChangedEvent} - * @param dataSet data set + * @param dataSet data set. Can be null */ public DataChangedEvent(DataSet dataSet) { Index: trunk/src/org/openstreetmap/josm/data/osm/event/DataSetListenerAdapter.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/DataSetListenerAdapter.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/DataSetListenerAdapter.java (revision 11928) @@ -4,12 +4,19 @@ /** * Classes that do not wish to implement all methods of DataSetListener - * may use this class. Implement DatasetListenerAdapter.Listener and + * may use this class. Implement {@link DataSetListenerAdapter.Listener} and * pass this adapter instead of class itself. - * + * @since 2622 */ public class DataSetListenerAdapter implements DataSetListener { + /** + * Single method dataset change event listener. + */ @FunctionalInterface public interface Listener { + /** + * Called when notified about any type of dataset change event. + * @param event dataset change event + */ void processDatasetEvent(AbstractDatasetChangedEvent event); } @@ -17,4 +24,8 @@ private final Listener listener; + /** + * Constructs a new {@code DataSetListenerAdapter}. + * @param listener listener for which its {@code processDatasetEvent()} method will be called for all events + */ public DataSetListenerAdapter(Listener listener) { this.listener = listener; Index: trunk/src/org/openstreetmap/josm/data/osm/event/DatasetEventManager.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/DatasetEventManager.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/DatasetEventManager.java (revision 11928) @@ -93,4 +93,7 @@ } + /** + * Event firing mode regarding Event Dispatch Thread. + */ public enum FireMode { /** @@ -167,4 +170,8 @@ } + /** + * Unregister listener. + * @param listener listener to remove + */ public void removeDatasetListener(DataSetListener listener) { ListenerInfo searchListener = new ListenerInfo(listener, false); Index: trunk/src/org/openstreetmap/josm/data/osm/event/NodeMovedEvent.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/NodeMovedEvent.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/NodeMovedEvent.java (revision 11928) @@ -13,4 +13,9 @@ private final Node node; + /** + * Constructs a new {@code NodeMovedEvent}. + * @param dataSet the dataset from which the event comes from + * @param node the node affected by the move + */ public NodeMovedEvent(DataSet dataSet, Node node) { super(dataSet); @@ -23,4 +28,8 @@ } + /** + * Returns the node affected by the move. + * @return the node affected by the move + */ public Node getNode() { return node; @@ -36,4 +45,3 @@ return DatasetEventType.NODE_MOVED; } - } Index: trunk/src/org/openstreetmap/josm/data/osm/event/PrimitiveFlagsChangedEvent.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/PrimitiveFlagsChangedEvent.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/PrimitiveFlagsChangedEvent.java (revision 11928) @@ -15,4 +15,9 @@ private final OsmPrimitive primitive; + /** + * Constructs a new {@code PrimitiveFlagsChangedEvent}. + * @param dataSet the dataset from which the event comes from + * @param primitive the primitive affected by the change + */ public PrimitiveFlagsChangedEvent(DataSet dataSet, OsmPrimitive primitive) { super(dataSet); Index: trunk/src/org/openstreetmap/josm/data/osm/event/PrimitivesAddedEvent.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/PrimitivesAddedEvent.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/PrimitivesAddedEvent.java (revision 11928) @@ -15,4 +15,10 @@ private final boolean wasIncomplete; + /** + * Constructs a new {@code PrimitivesAddedEvent}. + * @param dataSet the dataset from which the event comes from + * @param primitives the list of primitives affected by the change + * @param wasIncomplete {@code true} if primitive was in dataset before (so it's not really added), but it was incomplete + */ public PrimitivesAddedEvent(DataSet dataSet, Collection primitives, boolean wasIncomplete) { super(dataSet); @@ -32,6 +38,6 @@ /** - * - * @return True if primitive was in dataset before (so it's not really added), but it was incomplete + * Determines if primitive was in dataset before (so it's not really added), but it was incomplete + * @return {@code true} if primitive was in dataset before (so it's not really added), but it was incomplete */ public boolean wasIncomplete() { Index: trunk/src/org/openstreetmap/josm/data/osm/event/PrimitivesRemovedEvent.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/PrimitivesRemovedEvent.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/PrimitivesRemovedEvent.java (revision 11928) @@ -15,4 +15,10 @@ private final boolean wasComplete; + /** + * Constructs a new {@code PrimitivesRemovedEvent}. + * @param dataSet the dataset from which the event comes from + * @param primitives the list of primitives affected by the change + * @param wasComplete {@code true} if primitive wasn't really removed from the dataset, it only become incomplete again + */ public PrimitivesRemovedEvent(DataSet dataSet, Collection primitives, boolean wasComplete) { super(dataSet); @@ -32,6 +38,6 @@ /** - * - * @return True if primitive wasn't really removed from the dataset, it only become incomplete again + * Determines if primitive wasn't really removed from the dataset, it only become incomplete again. + * @return {@code true} if primitive wasn't really removed from the dataset, it only become incomplete again */ public boolean wasComplete() { Index: trunk/src/org/openstreetmap/josm/data/osm/event/RelationMembersChangedEvent.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/RelationMembersChangedEvent.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/RelationMembersChangedEvent.java (revision 11928) @@ -13,4 +13,9 @@ private final Relation relation; + /** + * Constructs a new {@code RelationMembersChangedEvent}. + * @param dataSet the dataset from which the event comes from + * @param relation the relation affected by the change + */ public RelationMembersChangedEvent(DataSet dataSet, Relation relation) { super(dataSet); @@ -23,4 +28,8 @@ } + /** + * Returns the relation affected by the change. + * @return the relation affected by the change + */ public Relation getRelation() { return relation; Index: trunk/src/org/openstreetmap/josm/data/osm/event/SelectionEventManager.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/SelectionEventManager.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/SelectionEventManager.java (revision 11928) @@ -17,5 +17,5 @@ * Similar like {@link DatasetEventManager}, just for selection events. Because currently selection changed * event are global, only FIRE_IN_EDT and FIRE_EDT_CONSOLIDATED modes are really useful - * + * @since 2912 */ public class SelectionEventManager implements SelectionChangedListener { @@ -23,4 +23,8 @@ private static final SelectionEventManager instance = new SelectionEventManager(); + /** + * Returns the unique instance. + * @return the unique instance + */ public static SelectionEventManager getInstance() { return instance; @@ -59,4 +63,9 @@ } + /** + * Registers a new {@code SelectionChangedListener}. + * @param listener listener to add + * @param fireMode EDT firing mode + */ public void addSelectionListener(SelectionChangedListener listener, FireMode fireMode) { if (fireMode == FireMode.IN_EDT) @@ -69,4 +78,8 @@ } + /** + * Unregisters a {@code SelectionChangedListener}. + * @param listener listener to remove + */ public void removeSelectionListener(SelectionChangedListener listener) { ListenerInfo searchListener = new ListenerInfo(listener); Index: trunk/src/org/openstreetmap/josm/data/osm/event/TagsChangedEvent.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/TagsChangedEvent.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/TagsChangedEvent.java (revision 11928) @@ -14,4 +14,10 @@ private final Map originalKeys; + /** + * Constructs a new {@code TagsChangedEvent}. + * @param dataSet the dataset from which the event comes from + * @param primitive the primitive affected by the change + * @param originalKeys the original tags + */ public TagsChangedEvent(DataSet dataSet, OsmPrimitive primitive, Map originalKeys) { super(dataSet); @@ -25,4 +31,8 @@ } + /** + * Returns the primitive affected by the change. + * @return the primitive affected by the change + */ public OsmPrimitive getPrimitive() { return primitive; @@ -39,4 +49,8 @@ } + /** + * Returns the original tags. + * @return the original tags + */ public Map getOriginalKeys() { return originalKeys; Index: trunk/src/org/openstreetmap/josm/data/osm/event/WayNodesChangedEvent.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/osm/event/WayNodesChangedEvent.java (revision 11926) +++ trunk/src/org/openstreetmap/josm/data/osm/event/WayNodesChangedEvent.java (revision 11928) @@ -13,4 +13,9 @@ private final Way way; + /** + * Constructs a new {@code WayNodesChangedEvent}. + * @param dataSet the dataset from which the event comes from + * @param way the way affected by the change + */ public WayNodesChangedEvent(DataSet dataSet, Way way) { super(dataSet); @@ -23,4 +28,8 @@ } + /** + * Returns the way affected by the change. + * @return the way affected by the change + */ public Way getChangedWay() { return way;