de.westnordost.osmapi.changesets

Class ChangesetsApi

java.lang.Object

de.westnordost.osmapi.changesets.ChangesetsApi

public class ChangesetsApi
extends java.lang.Object

Gets information for, searches for and shows changeset discussions. All interactions with this class require an OsmConnection with a logged in user.

Constructor Summary

Constructors

Constructor and Description
ChangesetsApi(de.westnordost.osmapi.OsmConnection osm)

Method Summary

Modifier and Type	Method and Description
ChangesetInfo	comment(long id, java.lang.String text) Add a comment to the given changeset.
void	find(de.westnordost.osmapi.common.Handler<ChangesetInfo> handler, QueryChangesetsFilters filters) Get a number of changesets that match the given filters.
ChangesetInfo	get(long id) Get the changeset information with the given id.
void	getData(long id, de.westnordost.osmapi.map.changes.MapDataChangesHandler handler) Get map data changes associated with the given changeset, using the default OsmMapDataFactory
void	getData(long id, de.westnordost.osmapi.map.changes.MapDataChangesHandler handler, de.westnordost.osmapi.map.MapDataFactory factory) Get map data changes associated with the given changeset.
ChangesetInfo	subscribe(long id) Subscribe the user to a changeset discussion.
ChangesetInfo	unsubscribe(long id) Unsubscribe the user from a changeset discussion.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChangesetsApi

public ChangesetsApi(de.westnordost.osmapi.OsmConnection osm)

Method Detail

get

public ChangesetInfo get(long id)

Get the changeset information with the given id. Always includes the changeset discussion.

Parameters:

id - changeset id

Returns:

info for the given changeset. Null if it does not exist.

find

public void find(de.westnordost.osmapi.common.Handler<ChangesetInfo> handler,
                 QueryChangesetsFilters filters)

Get a number of changesets that match the given filters.

Parameters:

handler - The handler which is fed the incoming changeset infos

filters - what to search for. I.e. new QueryChangesetsFilters().byUser(123).onlyClosed()

Throws:

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if not logged in

comment

public ChangesetInfo comment(long id,
                             java.lang.String text)

Add a comment to the given changeset. The changeset must already be closed. Adding a comment to a changeset automatically subscribes the user to it. TODO monitor https://github.com/openstreetmap/openstreetmap-website/issues/1165

Parameters:

id - id of the changeset

text - text to add to the changeset. Must not be empty

Returns:

the updated changeset

Throws:

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if this application is not authorized to modify the map (Permission.MODIFY_MAP)

de.westnordost.osmapi.common.errors.OsmConflictException - if the changeset is not yet closed. (Only closed changesets can be commented

subscribe

public ChangesetInfo subscribe(long id)

Subscribe the user to a changeset discussion. The changeset must be closed already.

Parameters:

id - id of the changeset

Returns:

the changeset

Throws:

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if this application is not authorized to modify the map (Permission.MODIFY_MAP)

de.westnordost.osmapi.common.errors.OsmNotFoundException - if the given changeset does not exist

unsubscribe

public ChangesetInfo unsubscribe(long id)

Unsubscribe the user from a changeset discussion. The changeset must be closed already.

Parameters:

id - id of the changeset

Returns:

the changeset

Throws:

de.westnordost.osmapi.common.errors.OsmAuthorizationException - if this application is not authorized to modify the map (Permission.MODIFY_MAP)

de.westnordost.osmapi.common.errors.OsmNotFoundException - if the given changeset does not exist

getData

public void getData(long id,
                    de.westnordost.osmapi.map.changes.MapDataChangesHandler handler)

Get map data changes associated with the given changeset, using the default OsmMapDataFactory

See Also:

getData(long, MapDataChangesHandler, MapDataFactory)

getData

public void getData(long id,
                    de.westnordost.osmapi.map.changes.MapDataChangesHandler handler,
                    de.westnordost.osmapi.map.MapDataFactory factory)

Get map data changes associated with the given changeset.

Parameters:

id - id of the changeset to get the data for

handler - handler to feed the map data changes to

factory - factory that creates the elements

Throws:

de.westnordost.osmapi.common.errors.OsmNotFoundException - if changeset with the given id does not exist