|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.fortuna.ical4j.model.PeriodList
public class PeriodList
$Id$ [23-Apr-2004]
Defines a list of iCalendar periods. NOTE: By implementing the
java.util.SortedSet
interface period lists will always be
sorted according to natural ordering.
Constructor Summary | |
---|---|
PeriodList()
Default constructor. |
|
PeriodList(boolean utc)
|
|
PeriodList(boolean utc,
boolean unmodifiable)
|
|
PeriodList(String aValue)
Parses the specified string representation to create a list of periods. |
Method Summary | |
---|---|
boolean |
add(Object period)
Overrides superclass to throw an IllegalArgumentException
where argument is not a net.fortuna.ical4j.model.Period . |
boolean |
add(Period period)
Add a period to the list. |
PeriodList |
add(PeriodList periods)
A convenience method that combines all the periods in the specified list to this list. |
boolean |
addAll(Collection arg0)
|
void |
clear()
|
boolean |
contains(Object o)
|
boolean |
containsAll(Collection arg0)
|
boolean |
equals(Object obj)
|
TimeZone |
getTimeZone()
|
int |
hashCode()
|
boolean |
isEmpty()
|
boolean |
isUnmodifiable()
|
boolean |
isUtc()
Indicates whether this list is in local or UTC format. |
Iterator |
iterator()
|
PeriodList |
normalise()
Returns a normalised version of this period list. |
boolean |
remove(Object o)
|
boolean |
remove(Period period)
Remove a period from the list. |
boolean |
removeAll(Collection arg0)
|
boolean |
retainAll(Collection arg0)
|
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()
|
PeriodList |
subtract(PeriodList subtractions)
Subtracts the intersection of this list with the specified list of periods from this list and returns the results as a new period list. |
Object[] |
toArray()
|
Object[] |
toArray(Object[] arg0)
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PeriodList()
public PeriodList(boolean utc)
utc
- indicates whether the period list is in UTC timepublic PeriodList(boolean utc, boolean unmodifiable)
utc
- indicates whether the period list is in UTC timepublic PeriodList(String aValue) throws ParseException
aValue
- a string representation of a list of periods
ParseException
- thrown when an invalid string representation of a period list
is specifiedMethod Detail |
---|
public final String toString()
toString
in class Object
public final boolean add(Period period)
period
- the period to add
List.add(java.lang.Object)
public final boolean add(Object period)
IllegalArgumentException
where argument is not a net.fortuna.ical4j.model.Period
.
add
in interface Collection
add
in interface Set
period
- a period to add to the list
java.util.List#add(E)
public final boolean remove(Period period)
period
- the period to remove
List.remove(java.lang.Object)
public final PeriodList normalise()
public final PeriodList add(PeriodList periods)
periods
- a list of periods to add
public final PeriodList subtract(PeriodList subtractions)
subtractions
- a list of periods to subtract from this list
public final boolean isUnmodifiable()
public final boolean isUtc()
public final void setUtc(boolean utc)
utc
- The utc to set.public final void setTimeZone(TimeZone timeZone)
timeZone
- the timezone for the period listpublic final TimeZone getTimeZone()
public final boolean addAll(Collection arg0)
addAll
in interface Collection
addAll
in interface Set
public final void clear()
clear
in interface Collection
clear
in interface Set
public final boolean contains(Object o)
contains
in interface Collection
contains
in interface Set
public final boolean containsAll(Collection arg0)
containsAll
in interface Collection
containsAll
in interface Set
public final boolean isEmpty()
isEmpty
in interface Collection
isEmpty
in interface Set
public final Iterator iterator()
iterator
in interface Iterable
iterator
in interface Collection
iterator
in interface Set
public final boolean remove(Object o)
remove
in interface Collection
remove
in interface Set
public final boolean removeAll(Collection arg0)
removeAll
in interface Collection
removeAll
in interface Set
public final boolean retainAll(Collection arg0)
retainAll
in interface Collection
retainAll
in interface Set
public final int size()
size
in interface Collection
size
in interface Set
public final Object[] toArray()
toArray
in interface Collection
toArray
in interface Set
public final Object[] toArray(Object[] arg0)
toArray
in interface Collection
toArray
in interface Set
public final boolean equals(Object obj)
equals
in interface Collection
equals
in interface Set
equals
in class Object
public final int hashCode()
hashCode
in interface Collection
hashCode
in interface Set
hashCode
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |