Serialized Form (osmapi 3.2 API)

Package de.westnordost.osmapi.capabilities
- Class de.westnordost.osmapi.capabilities.Capabilities extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - minSupportedApiVersion
```
float minSupportedApiVersion
```
    - maxSupportedApiVersion
```
float maxSupportedApiVersion
```
    - maxMapQueryAreaInSquareDegrees
```
float maxMapQueryAreaInSquareDegrees
```
    - maxNotesQueryAreaInSquareDegrees
```
float maxNotesQueryAreaInSquareDegrees
```
    - maxNodesInWay
```
int maxNodesInWay
```
    - maxPointsInGpsTracePerPage
```
int maxPointsInGpsTracePerPage
```
      See http://wiki.openstreetmap.org/wiki/API_v0.6#Retrieving_GPS_points
    - maxElementsPerChangeset
```
int maxElementsPerChangeset
```
    - timeoutInSeconds
```
int timeoutInSeconds
```
    - databaseStatus
```
Capabilities.ApiStatus databaseStatus
```
    - mapDataStatus
```
Capabilities.ApiStatus mapDataStatus
```
    - gpsTracesStatus
```
Capabilities.ApiStatus gpsTracesStatus
```
    - imageryBlacklistRegExes
```
java.util.List<E> imageryBlacklistRegExes
```
      list of regular expressions to match URLs from which the use of imagery is prohibited explicitly by the API. Naturally, this is not an exhaustive list, it is only to save users from attempting to use imagery from sources obviously not allowed for OSM. I.e. anything google. Note that if the server did not send this information, this method returns null.
Package de.westnordost.osmapi.changesets
- Class de.westnordost.osmapi.changesets.Changeset extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
long id
```
    - date
```
java.util.Date date
```
      the date of the changeset. (It is deliberately unspecified whether this is the creation or closed date, see note below)
      Note that the OSM API does actually not give out this information per changeset but for each element last edited as committing a changeset in OSM is not an atomic operation. For convenience, an edited date of an element included in the changeset is put here additionally. (In an element, this is the dateEdited property.)
    - user
```
User user
```
- Class de.westnordost.osmapi.changesets.ChangesetInfo extends Changeset implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - tags
```
java.util.Map<K,V> tags
```
      map of tags associated with this changeset. May be null if there are no tags at all.
    - discussion
```
java.util.List<E> discussion
```
      The changeset discussion. May be null if there is none
    - notesCount
```
int notesCount
```
      the number of notes in the changeset discussion of this changeset
    - boundingBox
```
BoundingBox boundingBox
```
      the bounding box that includes all changes of this changeset. May be null if the changeset is empty.
    - isOpen
```
boolean isOpen
```
    - dateClosed
```
java.util.Date dateClosed
```
      the date the changeset was closed. Null if the changeset is still open
    - dateCreated
```
java.util.Date dateCreated
```
      the date the changeset was created. Null if the changeset is still open
- Class de.westnordost.osmapi.changesets.ChangesetNote extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - date
```
java.util.Date date
```
    - user
```
User user
```
    - text
```
java.lang.String text
```
Package de.westnordost.osmapi.common
- Class de.westnordost.osmapi.common.Iso8601CompatibleDateFormat extends java.text.SimpleDateFormat implements Serializable
  
  serialVersionUID:
  
  1L
Package de.westnordost.osmapi.common.errors
- Class de.westnordost.osmapi.common.errors.OsmApiException extends java.lang.RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - errorCode
```
int errorCode
```
    - errorTitle
```
java.lang.String errorTitle
```
    - description
```
java.lang.String description
```
- Class de.westnordost.osmapi.common.errors.OsmApiReadResponseException extends java.lang.RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.westnordost.osmapi.common.errors.OsmAuthorizationException extends OsmApiException implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.westnordost.osmapi.common.errors.OsmBadUserInputException extends OsmApiException implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.westnordost.osmapi.common.errors.OsmConflictException extends OsmApiException implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.westnordost.osmapi.common.errors.OsmConnectionException extends java.lang.RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - errorCode
```
int errorCode
```
    - errorTitle
```
java.lang.String errorTitle
```
    - description
```
java.lang.String description
```
- Class de.westnordost.osmapi.common.errors.OsmNotFoundException extends OsmApiException implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.westnordost.osmapi.common.errors.OsmQueryTooBigException extends OsmBadUserInputException implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.westnordost.osmapi.common.errors.OsmServiceUnavailableException extends OsmConnectionException implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.westnordost.osmapi.common.errors.RedirectedException extends java.io.IOException implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.westnordost.osmapi.common.errors.XmlParserException extends java.lang.RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
Package de.westnordost.osmapi.map.changes
- Class de.westnordost.osmapi.map.changes.DiffElement extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - type
```
Element.Type type
```
    - clientId
```
long clientId
```
      aka old_id: the (placeholder) id the element had when the client sent it.
    - serverId
```
java.lang.Long serverId
```
      aka new_id: the id the element now has on the server. Can be null if it i.e. a deleted element
    - serverVersion
```
java.lang.Integer serverVersion
```
      aka new_version: the new version element now has on the server. Can be null if it i.e. a deleted element
Package de.westnordost.osmapi.map.data
- Class de.westnordost.osmapi.map.data.BoundingBox extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - min
```
LatLon min
```
    - max
```
LatLon max
```
- Class de.westnordost.osmapi.map.data.Fixed1E7LatLon extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - latitude
```
int latitude
```
    - longitude
```
int longitude
```
- Class de.westnordost.osmapi.map.data.ModificationAwareList extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - list
```
java.util.List<E> list
```
    - modified
```
boolean modified
```
- Class de.westnordost.osmapi.map.data.ModificationAwareMap extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - map
```
java.util.Map<K,V> map
```
    - modified
```
boolean modified
```
- Class de.westnordost.osmapi.map.data.OsmElement extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
long id
```
    - version
```
int version
```
    - changeset
```
Changeset changeset
```
    - dateEdited
```
java.util.Date dateEdited
```
    - tags
```
OsmTags tags
```
    - deleted
```
boolean deleted
```
    - modified
```
boolean modified
```
- Class de.westnordost.osmapi.map.data.OsmLatLon extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  2L
  - Serialized Fields
    - latitude
```
double latitude
```
    - longitude
```
double longitude
```
- Class de.westnordost.osmapi.map.data.OsmNode extends OsmElement implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - modified
```
boolean modified
```
    - pos
```
LatLon pos
```
- Class de.westnordost.osmapi.map.data.OsmRelation extends OsmElement implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - members
```
ModificationAwareList<T> members
```
- Class de.westnordost.osmapi.map.data.OsmRelationMember extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - modified
```
boolean modified
```
    - ref
```
long ref
```
    - type
```
Element.Type type
```
    - role
```
java.lang.String role
```
- Class de.westnordost.osmapi.map.data.OsmTags extends ModificationAwareMap<java.lang.String,java.lang.String> implements Serializable
  
  serialVersionUID:
  
  1L
- Class de.westnordost.osmapi.map.data.OsmWay extends OsmElement implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - nodes
```
ModificationAwareList<T> nodes
```
Package de.westnordost.osmapi.notes
- Class de.westnordost.osmapi.notes.Note extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - position
```
LatLon position
```
    - id
```
long id
```
    - dateCreated
```
java.util.Date dateCreated
```
    - dateClosed
```
java.util.Date dateClosed
```
      the date the note was closed. May be null if the note is not closed.
    - status
```
Note.Status status
```
    - comments
```
java.util.List<E> comments
```
- Class de.westnordost.osmapi.notes.NoteComment extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - date
```
java.util.Date date
```
    - action
```
NoteComment.Action action
```
    - text
```
java.lang.String text
```
    - user
```
User user
```
      the user who wrote the comment. May be null if the user is anonymous
Package de.westnordost.osmapi.traces
- Class de.westnordost.osmapi.traces.GpsTraceDetails extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
long id
```
    - name
```
java.lang.String name
```
    - position
```
LatLon position
```
      null until the whole trace has been imported completely by the server
    - userName
```
java.lang.String userName
```
      (current) user name of the uploader
    - visibility
```
GpsTraceDetails.Visibility visibility
```
    - pending
```
boolean pending
```
      whether the server did not complete the import of the trace yet
    - date
```
java.util.Date date
```
    - description
```
java.lang.String description
```
      may be empty/null
    - tags
```
java.util.List<E> tags
```
      may be empty/null
- Class de.westnordost.osmapi.traces.GpsTrackpoint extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - isFirstPointInTrackSegment
```
boolean isFirstPointInTrackSegment
```
      whether this trackpoint is the first point in a new segment/track (no differentiation made)
    - position
```
LatLon position
```
    - time
```
java.util.Date time
```
      null if unknown. The time is only specified in tracks uploaded with the visibility identifiable or trackable (see GpsTraceDetails)
    - horizontalDilutionOfPrecision
```
java.lang.Float horizontalDilutionOfPrecision
```
    - elevation
```
java.lang.Float elevation
```
Package de.westnordost.osmapi.user
- Class de.westnordost.osmapi.user.User extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
long id
```
    - displayName
```
java.lang.String displayName
```
- Class de.westnordost.osmapi.user.UserDetails extends UserInfo implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - considersHisContributionsAsPublicDomain
```
boolean considersHisContributionsAsPublicDomain
```
    - homeZoom
```
java.lang.Byte homeZoom
```
      user's self-chosen home zoom level is something between 0-19. Null if not set.
    - homeLocation
```
LatLon homeLocation
```
      user's self-chosen home location. Null if not set.
    - preferredLanguages
```
java.util.List<E> preferredLanguages
```
      the language and country codes of the user's preferred languages, sorted by preferedness. The format is i.e. "en-US" or "en" (according to ISO 639-1 and ISO 3166)
    - inboxMessageCount
```
int inboxMessageCount
```
    - unreadMessagesCount
```
int unreadMessagesCount
```
    - sentMessagesCount
```
int sentMessagesCount
```
- Class de.westnordost.osmapi.user.UserInfo extends User implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - createdDate
```
java.util.Date createdDate
```
    - changesetsCount
```
int changesetsCount
```
      aka the number of edits
    - gpsTracesCount
```
int gpsTracesCount
```
    - profileImageUrl
```
java.lang.String profileImageUrl
```
      URL to the user's profile picture. May be null if no profile picture has been chosen.
    - profileDescription
```
java.lang.String profileDescription
```
      The profile description is formatted with markdown. May be null if no description was provided.
    - hasAgreedToContributorTerms
```
boolean hasAgreedToContributorTerms
```
    - roles
```
java.util.List<E> roles
```
      may be null if the user has no roles
    - isBlocked
```
boolean isBlocked
```
      whether the user is currently blocked (=cannot make any modifications on the map).

Serialized Form

Package de.westnordost.osmapi.capabilities

Class de.westnordost.osmapi.capabilities.Capabilities extends java.lang.Object implements Serializable

Serialized Fields

minSupportedApiVersion

maxSupportedApiVersion

maxMapQueryAreaInSquareDegrees

maxNotesQueryAreaInSquareDegrees

maxNodesInWay

maxPointsInGpsTracePerPage

maxElementsPerChangeset

timeoutInSeconds

databaseStatus

mapDataStatus

gpsTracesStatus

imageryBlacklistRegExes

Package de.westnordost.osmapi.changesets

Class de.westnordost.osmapi.changesets.Changeset extends java.lang.Object implements Serializable

Serialized Fields

id

date

user

Class de.westnordost.osmapi.changesets.ChangesetInfo extends Changeset implements Serializable

Serialized Fields

tags

discussion

notesCount

boundingBox

isOpen

dateClosed

dateCreated

Class de.westnordost.osmapi.changesets.ChangesetNote extends java.lang.Object implements Serializable

Serialized Fields

date

user

text

Package de.westnordost.osmapi.common

Class de.westnordost.osmapi.common.Iso8601CompatibleDateFormat extends java.text.SimpleDateFormat implements Serializable

Package de.westnordost.osmapi.common.errors

Class de.westnordost.osmapi.common.errors.OsmApiException extends java.lang.RuntimeException implements Serializable

Serialized Fields

errorCode

errorTitle

description

Class de.westnordost.osmapi.common.errors.OsmApiReadResponseException extends java.lang.RuntimeException implements Serializable

Class de.westnordost.osmapi.common.errors.OsmAuthorizationException extends OsmApiException implements Serializable

Class de.westnordost.osmapi.common.errors.OsmBadUserInputException extends OsmApiException implements Serializable

Class de.westnordost.osmapi.common.errors.OsmConflictException extends OsmApiException implements Serializable

Class de.westnordost.osmapi.common.errors.OsmConnectionException extends java.lang.RuntimeException implements Serializable

Serialized Fields

errorCode

errorTitle

description

Class de.westnordost.osmapi.common.errors.OsmNotFoundException extends OsmApiException implements Serializable

Class de.westnordost.osmapi.common.errors.OsmQueryTooBigException extends OsmBadUserInputException implements Serializable

Class de.westnordost.osmapi.common.errors.OsmServiceUnavailableException extends OsmConnectionException implements Serializable

Class de.westnordost.osmapi.common.errors.RedirectedException extends java.io.IOException implements Serializable

Class de.westnordost.osmapi.common.errors.XmlParserException extends java.lang.RuntimeException implements Serializable

Package de.westnordost.osmapi.map.changes

Class de.westnordost.osmapi.map.changes.DiffElement extends java.lang.Object implements Serializable

Serialized Fields

type

clientId

serverId

serverVersion

Package de.westnordost.osmapi.map.data

Class de.westnordost.osmapi.map.data.BoundingBox extends java.lang.Object implements Serializable

Serialized Fields

min

max

Class de.westnordost.osmapi.map.data.Fixed1E7LatLon extends java.lang.Object implements Serializable

Serialized Fields

latitude

longitude

Class de.westnordost.osmapi.map.data.ModificationAwareList extends java.lang.Object implements Serializable

Serialized Fields

list

modified

Class de.westnordost.osmapi.map.data.ModificationAwareMap extends java.lang.Object implements Serializable

Serialized Fields