java.lang.Object
com.esri.arcgisruntime.mapping.TimeExtent
Represents a span of time between a start time and end time. A time extent which represents an instant in
time has the start time and end time set to the same value. TimeExtent is returned in the meta-data for time-aware
services and layers. It is often used to create a time slider ranging from a start time to an end time.
Start and end times of the time extent can be made unbounded by using
MIN_CALENDAR
and MAX_CALENDAR
for the start and end times e.g. TimeExtent t = new TimeExtent(MIN_CALENDAR, end)
would create a
time extent with unbounded start and an end time specified by end
.- Since:
- 100.3.0
-
Field Summary
-
Constructor Summary
ConstructorDescriptionTimeExtent
(Calendar timeInstant) Creates a time extent with a time instant.TimeExtent
(Calendar start, Calendar end) Creates a time extent with the given start and end times. -
Method Summary
Modifier and TypeMethodDescriptionGets the end time of this time extent.Gets the start time of this time extent.
-
Field Details
-
MIN_CALENDAR
The minimum possible calendar date.- Since:
- 100.3.0
-
MAX_CALENDAR
The maximum possible calendar date.- Since:
- 100.3.0
-
-
Constructor Details
-
TimeExtent
Creates a time extent with a time instant.- Parameters:
timeInstant
- the time instant is both the start and end time of the extent- Throws:
IllegalArgumentException
- if timeInstant is null- Since:
- 100.3.0
-
TimeExtent
Creates a time extent with the given start and end times.- Parameters:
start
- the start timeend
- the end time- Throws:
IllegalArgumentException
- if start is nullIllegalArgumentException
- if end is nullArcGISRuntimeException
- if the end time is before the start time- Since:
- 100.3.0
-
-
Method Details
-
getEndTime
Gets the end time of this time extent.- Returns:
- the end time of this TimeExtent
- Since:
- 100.3.0
-
getStartTime
Gets the start time of this time extent.- Returns:
- the start time of this time extent
- Since:
- 100.3.0
-