Package net.fortuna.ical4j.model

Class DateList

java.lang.Object

net.fortuna.ical4j.model.DateList

All Implemented Interfaces:

Serializable, Iterable<Date>, Collection<Date>, List<Date>

public class DateList
extends Object
implements List<Date>, Serializable, Iterable<Date>

$Id$ [23-Apr-2004] Defines a list of iCalendar dates. If no value type is specified a list defaults to DATE-TIME instances.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DateList()	Default constructor.
DateList(boolean unmodifiable)
DateList(String aValue, Value aType)
DateList(String aValue, Value aType, TimeZone timezone)	Parses the specified string representation to create a list of dates.
DateList(DateList list, Value type)	Constructs a new date list of the specified type containing the dates in the specified list.
DateList(Value aType)
DateList(Value aType, TimeZone timezone)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	add(int arg0, Date arg1)
boolean	add(Date date)	Add a date to the list.
boolean	addAll(int arg0, Collection<? extends Date> arg1)
boolean	addAll(Collection<? extends Date> arg0)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> arg0)
boolean	equals(Object obj)
Date	get(int index)
TimeZone	getTimeZone()
Value	getType()	Returns the VALUE parameter specifying the type of dates (ie.
int	hashCode()
int	indexOf(Object o)
boolean	isEmpty()
boolean	isUtc()	Indicates whether this list is in local or UTC format.
Iterator<Date>	iterator()
int	lastIndexOf(Object o)
ListIterator<Date>	listIterator()
ListIterator<Date>	listIterator(int index)
Date	remove(int index)
boolean	remove(Object o)
boolean	remove(Date date)	Remove a date from the list.
boolean	removeAll(Collection<?> arg0)
boolean	retainAll(Collection<?> arg0)
Date	set(int arg0, Date arg1)
void	setTimeZone(TimeZone timeZone)	Applies the specified timezone to all dates in the list.
void	setUtc(boolean utc)	Sets whether this list is in UTC or local time format.
int	size()
List<Date>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T> T[]	toArray(T[] arg0)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Constructor Detail

DateList

public DateList()

Default constructor.

DateList

public DateList(boolean unmodifiable)

DateList

public DateList(Value aType)

Parameters:

aType - the type of dates contained by the instance

DateList

public DateList(Value aType,
                TimeZone timezone)

Default constructor.

Parameters:

aType - specifies the type of dates (either date or date-time)

timezone - the timezone to apply to dates contained by the instance

DateList

public DateList(String aValue,
                Value aType)
         throws ParseException

Parameters:

aValue - a string representation of a date list

aType - the date types contained in the instance

Throws:

ParseException - where the specified string is not a valid date list

DateList

public DateList(String aValue,
                Value aType,
                TimeZone timezone)
         throws ParseException

Parses the specified string representation to create a list of dates.

Parameters:

aValue - a string representation of a list of dates

aType - specifies the type of dates (either date or date-time)

timezone - the timezone to apply to contained dates

Throws:

ParseException - if an invalid date representation exists in the date list string

DateList

public DateList(DateList list,
                Value type)

Constructs a new date list of the specified type containing the dates in the specified list.

Parameters:

list - a list of dates to include in the new list

type - the type of the new list

Method Detail

toString

public final String toString()

Overrides:

toString in class Object

add

public final boolean add(Date date)

Add a date to the list. The date will be updated to reflect the timezone of this list.

Specified by:

add in interface Collection<Date>

Specified by:

add in interface List<Date>

Parameters:

date - the date to add

Returns:

true

See Also:

List.add(java.lang.Object)

remove

public final boolean remove(Date date)

Remove a date from the list.

Parameters:

date - the date to remove

Returns:

true if the list contained the specified date

See Also:

List.remove(java.lang.Object)

getType

public final Value getType()

Returns the VALUE parameter specifying the type of dates (ie. date or date-time) stored in this date list.

Returns:

Returns a Value parameter.

isUtc

public final boolean isUtc()

Indicates whether this list is in local or UTC format. This property will have no affect if the type of the list is not DATE-TIME.

Returns:

Returns true if in UTC format, otherwise false.

setUtc

public final void setUtc(boolean utc)

Sets whether this list is in UTC or local time format.

Parameters:

utc - The utc to set.

setTimeZone

public final void setTimeZone(TimeZone timeZone)

Applies the specified timezone to all dates in the list. All dates added to this list will also have this timezone applied.

Parameters:

timeZone - a timezone to apply to contained dates

getTimeZone

public final TimeZone getTimeZone()

Returns:

Returns the timeZone.

add

public final void add(int arg0,
                      Date arg1)

Specified by:

add in interface List<Date>

addAll

public final boolean addAll(Collection<? extends Date> arg0)

Specified by:

addAll in interface Collection<Date>

Specified by:

addAll in interface List<Date>

addAll

public final boolean addAll(int arg0,
                            Collection<? extends Date> arg1)

Specified by:

addAll in interface List<Date>

clear

public final void clear()

Specified by:

clear in interface Collection<Date>

Specified by:

clear in interface List<Date>

contains

public final boolean contains(Object o)

Specified by:

contains in interface Collection<Date>

Specified by:

contains in interface List<Date>

containsAll

public final boolean containsAll(Collection<?> arg0)

Specified by:

containsAll in interface Collection<Date>

Specified by:

containsAll in interface List<Date>

get

public final Date get(int index)

Specified by:

get in interface List<Date>

indexOf

public final int indexOf(Object o)

Specified by:

indexOf in interface List<Date>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Collection<Date>

Specified by:

isEmpty in interface List<Date>

iterator

public final Iterator<Date> iterator()

Specified by:

iterator in interface Collection<Date>

Specified by:

iterator in interface Iterable<Date>

Specified by:

iterator in interface List<Date>

lastIndexOf

public final int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<Date>

listIterator

public final ListIterator<Date> listIterator()

Specified by:

listIterator in interface List<Date>

listIterator

public final ListIterator<Date> listIterator(int index)

Specified by:

listIterator in interface List<Date>

remove

public final Date remove(int index)

Specified by:

remove in interface List<Date>

remove

public final boolean remove(Object o)

Specified by:

remove in interface Collection<Date>

Specified by:

remove in interface List<Date>

removeAll

public final boolean removeAll(Collection<?> arg0)

Specified by:

removeAll in interface Collection<Date>

Specified by:

removeAll in interface List<Date>

retainAll

public final boolean retainAll(Collection<?> arg0)

Specified by:

retainAll in interface Collection<Date>

Specified by:

retainAll in interface List<Date>

set

public final Date set(int arg0,
                      Date arg1)

Specified by:

set in interface List<Date>

size

public final int size()

Specified by:

size in interface Collection<Date>

Specified by:

size in interface List<Date>

subList

public final List<Date> subList(int fromIndex,
                                int toIndex)

Specified by:

subList in interface List<Date>

toArray

public final Object[] toArray()

Specified by:

toArray in interface Collection<Date>

Specified by:

toArray in interface List<Date>

toArray

public final <T> T[] toArray(T[] arg0)

Specified by:

toArray in interface Collection<Date>

Specified by:

toArray in interface List<Date>

equals

public final boolean equals(Object obj)

Specified by:

equals in interface Collection<Date>

Specified by:

equals in interface List<Date>

Overrides:

equals in class Object

hashCode

public final int hashCode()

Specified by:

hashCode in interface Collection<Date>

Specified by:

hashCode in interface List<Date>

Overrides:

hashCode in class Object