org.openstreetmap.josm.data.osm.history

Class History

java.lang.Object

org.openstreetmap.josm.data.osm.history.History

public class History
extends Object

Represents the history of an OSM primitive. The history consists of a list of object snapshots with a specific version.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static interface	History.FilterPredicate

Field Summary

Fields

Modifier and Type	Field and Description
private long	id the object id
private OsmPrimitiveType	type
private List<HistoryOsmPrimitive>	versions the list of object snapshots

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	History(long id, OsmPrimitiveType type, List<HistoryOsmPrimitive> versions) Creates a new history for an OSM primitive

Method Summary

Modifier and Type	Method and Description
History	between(Date fromDate, Date untilDate)
History	between(long fromVersion, long untilVersion)
boolean	contains(long version)
private static History	filter(History history, History.FilterPredicate predicate)
History	forUserId(long uid)
History	from(Date fromDate)
History	from(long fromVersion)
HistoryOsmPrimitive	get(int idx)
HistoryOsmPrimitive	getByDate(Date date)
HistoryOsmPrimitive	getByVersion(long version) Replies the history primitive with version version. null, if no such primitive exists.
HistoryOsmPrimitive	getEarliest()
long	getId()
HistoryOsmPrimitive	getLatest()
int	getNumVersions()
PrimitiveId	getPrimitiveId() Replies the primitive id for this history.
OsmPrimitiveType	getType()
boolean	isEmpty()
History	sortAscending()
History	sortDescending()
String	toString()
History	until(Date untilDate)
History	until(long untilVersion)

Methods inherited from class java.lang.Object

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

Field Detail

versions

private List<HistoryOsmPrimitive> versions

the list of object snapshots

id

private final long id

the object id

type

private final OsmPrimitiveType type

Constructor Detail

History

protected History(long id,
                  OsmPrimitiveType type,
                  List<HistoryOsmPrimitive> versions)

Creates a new history for an OSM primitive

Parameters:

id - the id. >0 required.

type - the primitive type. Must not be null.

versions - a list of versions. Can be null.

Throws:

IllegalArgumentException - thrown if id <= 0

IllegalArgumentException - if type is null

Method Detail

filter

private static History filter(History history,
                              History.FilterPredicate predicate)

sortAscending

public History sortAscending()

sortDescending

public History sortDescending()

from

public History from(Date fromDate)

until

public History until(Date untilDate)

between

public History between(Date fromDate,
                       Date untilDate)

from

public History from(long fromVersion)

until

public History until(long untilVersion)

between

public History between(long fromVersion,
                       long untilVersion)

forUserId

public History forUserId(long uid)

getId

public long getId()

getPrimitiveId

public PrimitiveId getPrimitiveId()

Replies the primitive id for this history.

Returns:

the primitive id

contains

public boolean contains(long version)

getByVersion

public HistoryOsmPrimitive getByVersion(long version)

Replies the history primitive with version version. null, if no such primitive exists.

Parameters:

version - the version

Returns:

the history primitive with version version

getByDate

public HistoryOsmPrimitive getByDate(Date date)

get

public HistoryOsmPrimitive get(int idx)

getEarliest

public HistoryOsmPrimitive getEarliest()

getLatest

public HistoryOsmPrimitive getLatest()

getNumVersions

public int getNumVersions()

isEmpty

public boolean isEmpty()

getType

public OsmPrimitiveType getType()

toString

public String toString()

Overrides:

toString in class Object