org.w3c.dom.smil20
Interface TimeList

All Known Implementing Classes:

TimeListImpl

public interface TimeList

The TimeList interface provides the abstraction of an ordered collection of times, without defining or constraining how this collection is implemented.

The items in the TimeList are accessible via an integral index, starting from 0.

Method Summary

int	getLength() The number of times in the list.
Time	getTimeGreaterThan(Time time) Get the next time greater than time.
boolean	isDefined() If this list has time instances - then the parameter was defined.
Time	item(int index) Returns the index th item in the collection.

Method Detail

item

public Time item(int index)

Returns the index th item in the collection. If index is greater than or equal to the number of times in the list, this returns null .

Parameters:

index - Index into the collection.

Returns:

The time at the index th position in the TimeList , or null if that is not a valid index.

getLength

public int getLength()

The number of times in the list. The range of valid child time indices is 0 to length-1 inclusive.

getTimeGreaterThan

public Time getTimeGreaterThan(Time time)

Get the next time greater than time.

Parameters:

time - Time to compare against

Returns:

Index to time item, -1 if not found

isDefined

public boolean isDefined()

If this list has time instances - then the parameter was defined.

Returns:

true if the TimeList is not empty - and parameter was specified.