net.fortuna.ical4j.model

Class DateList

java.lang.Object

net.fortuna.ical4j.model.DateList

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Date>, java.util.Collection<Date>, java.util.List<Date>

public class DateList
extends java.lang.Object
implements java.util.List<Date>, java.io.Serializable

$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 and Description
DateList() Default constructor.
DateList(boolean unmodifiable)
DateList(DateList list, Value type) Constructs a new date list of the specified type containing the dates in the specified list.
DateList(java.lang.String aValue, Value aType)
DateList(java.lang.String aValue, Value aType, TimeZone timezone) Parses the specified string representation to create a list of dates.
DateList(Value aType)
DateList(Value aType, TimeZone timezone) Default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	add(Date date) Add a date to the list.
void	add(int arg0, Date arg1)
boolean	addAll(java.util.Collection<? extends Date> arg0)
boolean	addAll(int arg0, java.util.Collection<? extends Date> arg1)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> arg0)
boolean	equals(java.lang.Object obj)
Date	get(int index)
TimeZone	getTimeZone()
Value	getType() Returns the VALUE parameter specifying the type of dates (ie.
int	hashCode()
int	indexOf(java.lang.Object o)
boolean	isEmpty()
boolean	isUtc() Indicates whether this list is in local or UTC format.
java.util.Iterator<Date>	iterator()
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator<Date>	listIterator()
java.util.ListIterator<Date>	listIterator(int index)
boolean	remove(Date date) Remove a date from the list.
Date	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> arg0)
boolean	retainAll(java.util.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()
java.util.List<Date>	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] arg0)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

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(java.lang.String aValue,
                Value aType)
         throws java.text.ParseException

Parameters:

aValue - a string representation of a date list

aType - the date types contained in the instance

Throws:

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

DateList

public DateList(java.lang.String aValue,
                Value aType,
                TimeZone timezone)
         throws java.text.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:

java.text.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 java.lang.String toString()

Overrides:

toString in class java.lang.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 java.util.Collection<Date>

Specified by:

add in interface java.util.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 java.util.List<Date>

addAll

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

Specified by:

addAll in interface java.util.Collection<Date>

Specified by:

addAll in interface java.util.List<Date>

addAll

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

Specified by:

addAll in interface java.util.List<Date>

clear

public final void clear()

Specified by:

clear in interface java.util.Collection<Date>

Specified by:

clear in interface java.util.List<Date>

contains

public final boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<Date>

Specified by:

contains in interface java.util.List<Date>

containsAll

public final boolean containsAll(java.util.Collection<?> arg0)

Specified by:

containsAll in interface java.util.Collection<Date>

Specified by:

containsAll in interface java.util.List<Date>

get

public final Date get(int index)

Specified by:

get in interface java.util.List<Date>

indexOf

public final int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<Date>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<Date>

Specified by:

isEmpty in interface java.util.List<Date>

iterator

public final java.util.Iterator<Date> iterator()

Specified by:

iterator in interface java.lang.Iterable<Date>

Specified by:

iterator in interface java.util.Collection<Date>

Specified by:

iterator in interface java.util.List<Date>

lastIndexOf

public final int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<Date>

listIterator

public final java.util.ListIterator<Date> listIterator()

Specified by:

listIterator in interface java.util.List<Date>

listIterator

public final java.util.ListIterator<Date> listIterator(int index)

Specified by:

listIterator in interface java.util.List<Date>

remove

public final Date remove(int index)

Specified by:

remove in interface java.util.List<Date>

remove

public final boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<Date>

Specified by:

remove in interface java.util.List<Date>

removeAll

public final boolean removeAll(java.util.Collection<?> arg0)

Specified by:

removeAll in interface java.util.Collection<Date>

Specified by:

removeAll in interface java.util.List<Date>

retainAll

public final boolean retainAll(java.util.Collection<?> arg0)

Specified by:

retainAll in interface java.util.Collection<Date>

Specified by:

retainAll in interface java.util.List<Date>

set

public final Date set(int arg0,
                      Date arg1)

Specified by:

set in interface java.util.List<Date>

size

public final int size()

Specified by:

size in interface java.util.Collection<Date>

Specified by:

size in interface java.util.List<Date>

subList

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

Specified by:

subList in interface java.util.List<Date>

toArray

public final java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<Date>

Specified by:

toArray in interface java.util.List<Date>

toArray

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

Specified by:

toArray in interface java.util.Collection<Date>

Specified by:

toArray in interface java.util.List<Date>

equals

public final boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Collection<Date>

Specified by:

equals in interface java.util.List<Date>

Overrides:

equals in class java.lang.Object

hashCode

public final int hashCode()

Specified by:

hashCode in interface java.util.Collection<Date>

Specified by:

hashCode in interface java.util.List<Date>

Overrides:

hashCode in class java.lang.Object