|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractSet<E>
java.util.TreeSet
net.fortuna.ical4j.model.PeriodList
public class PeriodList
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(String aValue)
Parses the specified string representation to create a list of periods. |
Method Summary | |
---|---|
boolean |
add(Object arg0)
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 adds all the periods in the specified list to this list. |
TimeZone |
getTimeZone()
|
boolean |
isUtc()
Indicates whether this list is in local or UTC format. |
PeriodList |
normalise()
Returns a normalised version of this period list. |
boolean |
remove(Period period)
Remove a period from the list. |
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. |
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. |
String |
toString()
|
Methods inherited from class java.util.TreeSet |
---|
addAll, clear, clone, comparator, contains, first, headSet, isEmpty, iterator, last, remove, size, subSet, tailSet |
Methods inherited from class java.util.AbstractSet |
---|
equals, hashCode, removeAll |
Methods inherited from class java.util.AbstractCollection |
---|
containsAll, retainAll, toArray, toArray |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Set |
---|
containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray |
Constructor Detail |
---|
public PeriodList()
public PeriodList(boolean utc)
utc
- public 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 AbstractCollection
AbstractCollection.toString()
public final boolean add(Period period)
period
- the period to add
List.add(java.lang.Object)
public final boolean add(Object arg0)
IllegalArgumentException
where argument is not a net.fortuna.ical4j.model.Period
.
add
in interface Collection
add
in interface Set
add
in class TreeSet
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
- public final PeriodList subtract(PeriodList subtractions)
periods
- a list of periods to subtract from this list
public final boolean isUtc()
public final void setUtc(boolean utc)
utc
- The utc to set.public final void setTimeZone(TimeZone timeZone)
timezone
- public final TimeZone getTimeZone()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |