VEvent (biweekly 0.5.0 API)

java.lang.Object
- biweekly.component.ICalComponent
- - biweekly.component.VEvent

public class VEvent
extends ICalComponent

Defines a scheduled activity, such as a two hour meeting.

Examples:

 VEvent event = new VEvent();
 Date start = ...
 event.setDateStart(start);
 Date end = ...
 event.setDateEnd(end);
 event.setSummary("Team Meeting");
 event.setLocation("Room 21C");
 event.setCreated(new Date());
 event.setRecurrenceRule(new Recurrence.Builder(Frequency.WEEKLY).build());

Author:: Michael Angstadt
See Also:: RFC 5545 p.52-5, RFC 2445 p.52-4, vCal 1.0 p.13

Field Summary
- Fields inherited from class biweekly.component.ICalComponent
  components, properties

Constructor Summary

Constructors
Constructor and Description

VEvent()
Creates a new event.

VEvent(VEvent original)
Copy constructor.

Constructors
Constructor and Description
`VEvent()` Creates a new event.
`VEvent(VEvent original)` Copy constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAlarm(VAlarm alarm)` Adds an alarm to this event.
`void`	`addAttachment(Attachment attachment)` Adds an attachment to the event.
`void`	`addAttendee(Attendee attendee)` Adds a person who is attending the event.
`Attendee`	`addAttendee(String email)` Adds a person who is attending the event.
`void`	`addCategories(Categories categories)` Adds a list of "tags" or "keywords" that describe the event.
`Categories`	`addCategories(List<String> categories)` Adds a list of "tags" or "keywords" that describe the event.
`Categories`	`addCategories(String... categories)` Adds a list of "tags" or "keywords" that describe the event.
`void`	`addComment(Comment comment)` Adds a comment to the event.
`Comment`	`addComment(String comment)` Adds a comment to the event.
`void`	`addConference(Conference conference)` Adds information related to the event's conference system.
`void`	`addContact(Contact contact)` Adds a contact to the event.
`Contact`	`addContact(String contact)` Adds a contact to the event.
`void`	`addExceptionDates(ExceptionDates exceptionDates)` Adds a list of exceptions to the recurrence rule defined in the event (if one is defined).
`void`	`addExceptionRule(ExceptionRule exceptionRule)` Adds an exception for the `RecurrenceRule` property.
`ExceptionRule`	`addExceptionRule(Recurrence recur)` Adds an exception for the `RecurrenceRule` property.
`void`	`addImage(Image image)` Adds an image that is associated with the event.
`void`	`addRecurrenceDates(RecurrenceDates recurrenceDates)` Adds a list of dates/periods that help define the recurrence rule of this event (if one is defined).
`void`	`addRelatedTo(RelatedTo relatedTo)` Adds a component that the event is related to.
`RelatedTo`	`addRelatedTo(String uid)` Adds a component that the event is related to.
`Resources`	`addResources(List<String> resources)` Adds a list of resources that are needed for the event.
`void`	`addResources(Resources resources)` Adds a list of resources that are needed for the event.
`Resources`	`addResources(String... resources)` Adds a list of resources that are needed for the event.
`VEvent`	`copy()` Creates a deep copy of this component object.
`List<VAlarm>`	`getAlarms()` Gets the alarms that are assigned to this event.
`List<Attachment>`	`getAttachments()` Gets any attachments that are associated with the event.
`List<Attendee>`	`getAttendees()` Gets the people who are attending the event.
`List<Categories>`	`getCategories()` Gets a list of "tags" or "keywords" that describe the event.
`Classification`	`getClassification()` Gets the level of sensitivity of the event data.
`Color`	`getColor()` Gets the color that clients may use when displaying the event (for example, a background color).
`List<Comment>`	`getComments()` Gets the comments attached to the event.
`List<Conference>`	`getConferences()` Gets information related to the event's conference system.
`List<Contact>`	`getContacts()` Gets the contacts associated with the event.
`Created`	`getCreated()` Gets the date-time that the event was initially created.
`DateEnd`	`getDateEnd()` Gets the date that the event ends.
`DateIterator`	`getDateIterator(TimeZone timezone)` Creates an iterator that computes the dates defined by the `RecurrenceRule` and `RecurrenceDates` properties (if present), and excludes those dates which are defined by the `ExceptionRule` and `ExceptionDates` properties (if present).
`DateStart`	`getDateStart()` Gets the date that the event starts.
`DateTimeStamp`	`getDateTimeStamp()` Gets either (a) the creation date of the iCalendar object (if the `Method` property is defined) or (b) the date that the event was last modified (the `LastModified` property also holds this information).
`Description`	`getDescription()` Gets a detailed description of the event.
`DurationProperty`	`getDuration()` Gets the duration of the event.
`List<ExceptionDates>`	`getExceptionDates()` Gets the list of exceptions to the recurrence rule defined in the event (if one is defined).
`List<ExceptionRule>`	`getExceptionRules()` Gets the exceptions for the `RecurrenceRule` property.
`Geo`	`getGeo()` Gets a set of geographical coordinates.
`List<Image>`	`getImages()` Gets the images that are associated with the event.
`LastModified`	`getLastModified()` Gets the date-time that the event was last changed.
`Location`	`getLocation()` Gets the physical location of the event.
`Organizer`	`getOrganizer()` Gets the organizer of the event.
`Priority`	`getPriority()` Gets the priority of the event.
`List<RecurrenceDates>`	`getRecurrenceDates()` Gets the list of dates/periods that help define the recurrence rule of this event (if one is defined).
`RecurrenceId`	`getRecurrenceId()` Gets the original value of the `DateStart` property if the event is recurring and has been modified.
`RecurrenceRule`	`getRecurrenceRule()` Gets how often the event repeats.
`List<RelatedTo>`	`getRelatedTo()` Gets the components that the event is related to.
`RequestStatus`	`getRequestStatus()` Gets the response to a scheduling request.
`List<Resources>`	`getResources()` Gets the resources that are needed for the event.
`Sequence`	`getSequence()` Gets the revision number of the event.
`Status`	`getStatus()` Gets the status of the event.
`Summary`	`getSummary()` Gets the summary of the event.
`Transparency`	`getTransparency()` Gets whether an event is visible to free/busy time searches.
`Uid`	`getUid()` Gets the unique identifier for this event.
`Url`	`getUrl()` Gets a URL to a resource that contains additional information about the event.
`void`	`incrementSequence()` Increments the revision number of the event.
`void`	`setClassification(Classification classification)` Sets the level of sensitivity of the event data.
`Classification`	`setClassification(String classification)` Sets the level of sensitivity of the event data.
`void`	`setColor(Color color)` Sets the color that clients may use when displaying the event (for example, a background color).
`Color`	`setColor(String color)` Sets the color that clients may use when displaying the event (for example, a background color).
`void`	`setCreated(Created created)` Sets the date-time that the event was initially created.
`Created`	`setCreated(Date created)` Sets the date-time that the event was initially created.
`DateEnd`	`setDateEnd(Date dateEnd)` Sets the date that the event ends.
`DateEnd`	`setDateEnd(Date dateEnd, boolean hasTime)` Sets the date that the event ends.
`void`	`setDateEnd(DateEnd dateEnd)` Sets the date that the event ends.
`DateStart`	`setDateStart(Date dateStart)` Sets the date that the event starts (required if no `Method` property is defined).
`DateStart`	`setDateStart(Date dateStart, boolean hasTime)` Sets the date that the event starts (required if no `Method` property is defined).
`void`	`setDateStart(DateStart dateStart)` Sets the date that the event starts (required if no `Method` property is defined).
`DateTimeStamp`	`setDateTimeStamp(Date dateTimeStamp)` Sets either (a) the creation date of the iCalendar object (if the `Method` property is defined) or (b) the date that the event was last modified (the `LastModified` property also holds this information).
`void`	`setDateTimeStamp(DateTimeStamp dateTimeStamp)` Sets either (a) the creation date of the iCalendar object (if the `Method` property is defined) or (b) the date that the event was last modified (the `LastModified` property also holds this information).
`void`	`setDescription(Description description)` Sets a detailed description of the event.
`Description`	`setDescription(String description)` Sets a detailed description of the event.
`DurationProperty`	`setDuration(Duration duration)` Sets the duration of the event.
`void`	`setDuration(DurationProperty duration)` Sets the duration of the event.
`void`	`setGeo(Geo geo)` Sets a set of geographical coordinates.
`LastModified`	`setLastModified(Date lastModified)` Sets the date-time that the event was last changed.
`void`	`setLastModified(LastModified lastModified)` Sets the date-time that event was last changed.
`void`	`setLocation(Location location)` Sets the physical location of the event.
`Location`	`setLocation(String location)` Sets the physical location of the event.
`void`	`setOrganizer(Organizer organizer)` Sets the organizer of the event.
`Organizer`	`setOrganizer(String email)` Sets the organizer of the event.
`Priority`	`setPriority(Integer priority)` Sets the priority of the event.
`void`	`setPriority(Priority priority)` Sets the priority of the event.
`RecurrenceId`	`setRecurrenceId(Date originalStartDate)` Sets the original value of the `DateStart` property if the event is recurring and has been modified.
`void`	`setRecurrenceId(RecurrenceId recurrenceId)` Sets the original value of the `DateStart` property if the event is recurring and has been modified.
`RecurrenceRule`	`setRecurrenceRule(Recurrence recur)` Sets how often the event repeats.
`void`	`setRecurrenceRule(RecurrenceRule recurrenceRule)` Sets how often the event repeats.
`void`	`setRequestStatus(RequestStatus requestStatus)` Sets the response to a scheduling request.
`Sequence`	`setSequence(Integer sequence)` Sets the revision number of the event.
`void`	`setSequence(Sequence sequence)` Sets the revision number of the event.
`void`	`setStatus(Status status)` Sets the status of the event.
`Summary`	`setSummary(String summary)` Sets the summary of the event.
`void`	`setSummary(Summary summary)` Sets the summary of the event.
`Transparency`	`setTransparency(Boolean transparent)` Sets whether an event is visible to free/busy time searches.
`void`	`setTransparency(Transparency transparency)` Sets whether an event is visible to free/busy time searches.
`Uid`	`setUid(String uid)` Sets the unique identifier for this event.
`void`	`setUid(Uid uid)` Sets the unique identifier for this event.
`Url`	`setUrl(String url)` Sets a URL to a resource that contains additional information about the event.
`void`	`setUrl(Url url)` Sets a URL to a resource that contains additional information about the event.
`protected void`	`validate(List<ICalComponent> components, ICalVersion version, List<Warning> warnings)` Checks the component for data consistency problems or deviations from the spec.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VEvent
```
public VEvent()
```
    Creates a new event.
    
    The following properties are added to the component when it is created:
    - Uid: Set to a UUID.
    - DateTimeStamp: Set to the current time.
  - VEvent
```
public VEvent(VEvent original)
```
    Copy constructor.
    
    Parameters:
    original - the component to make a copy of
- Method Detail
  - getUid
```
public Uid getUid()
```
    Gets the unique identifier for this event. This component object comes populated with a UID on creation. This is a required property.
    
    Returns:
    the UID or null if not set
    See Also:
    RFC 5545 p.117-8, RFC 2445 p.111-2, vCal 1.0 p.37
  - setUid
```
public void setUid(Uid uid)
```
    Sets the unique identifier for this event. This component object comes populated with a UID on creation. This is a required property.
    
    Parameters:
    uid - the UID or null to remove
    See Also:
    RFC 5545 p.117-8, RFC 2445 p.111-2, vCal 1.0 p.37
  - setUid
```
public Uid setUid(String uid)
```
    Sets the unique identifier for this event. This component object comes populated with a UID on creation. This is a required property.
    
    Parameters:
    uid - the UID or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.117-8, RFC 2445 p.111-2, vCal 1.0 p.37
  - getDateTimeStamp
```
public DateTimeStamp getDateTimeStamp()
```
    Gets either (a) the creation date of the iCalendar object (if the Method property is defined) or (b) the date that the event was last modified (the LastModified property also holds this information). This event object comes populated with a DateTimeStamp property that is set to the current time. This is a required property.
    
    Returns:
    the date time stamp or null if not set
    See Also:
    RFC 5545 p.137-8, RFC 2445 p.130-1
  - setDateTimeStamp
```
public void setDateTimeStamp(DateTimeStamp dateTimeStamp)
```
    Sets either (a) the creation date of the iCalendar object (if the Method property is defined) or (b) the date that the event was last modified (the LastModified property also holds this information). This event object comes populated with a DateTimeStamp property that is set to the current time. This is a required property.
    
    Parameters:
    dateTimeStamp - the date time stamp or null to remove
    See Also:
    RFC 5545 p.137-8, RFC 2445 p.130-1
  - setDateTimeStamp
```
public DateTimeStamp setDateTimeStamp(Date dateTimeStamp)
```
    Sets either (a) the creation date of the iCalendar object (if the Method property is defined) or (b) the date that the event was last modified (the LastModified property also holds this information). This event object comes populated with a DateTimeStamp property that is set to the current time. This is a required property.
    
    Parameters:
    dateTimeStamp - the date time stamp or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.137-8, RFC 2445 p.130-1
  - getDateStart
```
public DateStart getDateStart()
```
    Gets the date that the event starts.
    
    Returns:
    the start date or null if not set
    See Also:
    RFC 5545 p.97-8, RFC 2445 p.93-4, vCal 1.0 p.35
  - setDateStart
```
public void setDateStart(DateStart dateStart)
```
    Sets the date that the event starts (required if no Method property is defined).
    
    Parameters:
    dateStart - the start date or null to remove
    See Also:
    RFC 5545 p.97-8, RFC 2445 p.93-4, vCal 1.0 p.35
  - setDateStart
```
public DateStart setDateStart(Date dateStart)
```
    Sets the date that the event starts (required if no Method property is defined).
    
    Parameters:
    dateStart - the start date or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.97-8, RFC 2445 p.93-4, vCal 1.0 p.35
  - setDateStart
```
public DateStart setDateStart(Date dateStart,
                     boolean hasTime)
```
    Sets the date that the event starts (required if no Method property is defined).
    
    Parameters:
    dateStart - the start date or null to remove
    hasTime - true if the date has a time component, false if it is strictly a date (if false, the given Date object should be created by a Calendar object that uses the JVM's default timezone)
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.97-8, RFC 2445 p.93-4, vCal 1.0 p.35
  - getClassification
```
public Classification getClassification()
```
    Gets the level of sensitivity of the event data. If not specified, the data within the event should be considered "public".
    
    Returns:
    the classification level or null if not set
    See Also:
    RFC 5545 p.82-3, RFC 2445 p.79-80, vCal 1.0 p.28-9
  - setClassification
```
public void setClassification(Classification classification)
```
    Sets the level of sensitivity of the event data. If not specified, the data within the event should be considered "public".
    
    Parameters:
    classification - the classification level or null to remove
    See Also:
    RFC 5545 p.82-3, RFC 2445 p.79-80, vCal 1.0 p.28-9
  - setClassification
```
public Classification setClassification(String classification)
```
    Sets the level of sensitivity of the event data. If not specified, the data within the event should be considered "public".
    
    Parameters:
    classification - the classification level (e.g. "CONFIDENTIAL") or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.82-3, RFC 2445 p.79-80, vCal 1.0 p.28-9
  - getDescription
```
public Description getDescription()
```
    Gets a detailed description of the event. The description should be more detailed than the one provided by the Summary property.
    
    Returns:
    the description or null if not set
    See Also:
    RFC 5545 p.84-5, RFC 2445 p.81-2, vCal 1.0 p.30
  - setDescription
```
public void setDescription(Description description)
```
    Sets a detailed description of the event. The description should be more detailed than the one provided by the Summary property.
    
    Parameters:
    description - the description or null to remove
    See Also:
    RFC 5545 p.84-5, RFC 2445 p.81-2, vCal 1.0 p.30
  - setDescription
```
public Description setDescription(String description)
```
    Sets a detailed description of the event. The description should be more detailed than the one provided by the Summary property.
    
    Parameters:
    description - the description or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.84-5, RFC 2445 p.81-2, vCal 1.0 p.30
  - getGeo
```
public Geo getGeo()
```
    Gets a set of geographical coordinates.
    
    Returns:
    the geographical coordinates or null if not set
    See Also:
    RFC 5545 p.85-7, RFC 2445 p.82-3
  - setGeo
```
public void setGeo(Geo geo)
```
    Sets a set of geographical coordinates.
    
    Parameters:
    geo - the geographical coordinates or null to remove
    See Also:
    RFC 5545 p.85-7, RFC 2445 p.82-3
  - getLocation
```
public Location getLocation()
```
    Gets the physical location of the event.
    
    Returns:
    the location or null if not set
    See Also:
    RFC 5545 p.87-8, RFC 2445 p.84, vCal 1.0 p.32
  - setLocation
```
public void setLocation(Location location)
```
    Sets the physical location of the event.
    
    Parameters:
    location - the location or null to remove
    See Also:
    RFC 5545 p.87-8, RFC 2445 p.84, vCal 1.0 p.32
  - setLocation
```
public Location setLocation(String location)
```
    Sets the physical location of the event.
    
    Parameters:
    location - the location (e.g. "Room 101") or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.87-8, RFC 2445 p.84, vCal 1.0 p.32
  - getPriority
```
public Priority getPriority()
```
    Gets the priority of the event.
    
    Returns:
    the priority or null if not set
    See Also:
    RFC 5545 p.89-90, RFC 2445 p.85-7, vCal 1.0 p.33
  - setPriority
```
public void setPriority(Priority priority)
```
    Sets the priority of the event.
    
    Parameters:
    priority - the priority or null to remove
    See Also:
    RFC 5545 p.89-90, RFC 2445 p.85-7, vCal 1.0 p.33
  - setPriority
```
public Priority setPriority(Integer priority)
```
    Sets the priority of the event.
    
    Parameters:
    priority - the priority ("0" is undefined, "1" is the highest, "9" is the lowest) or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.89-90, RFC 2445 p.85-7, vCal 1.0 p.33
  - getStatus
```
public Status getStatus()
```
    Gets the status of the event.
    
    Returns:
    the status or null if not set
    See Also:
    RFC 5545 p.92-3, RFC 2445 p.88-9, vCal 1.0 p.35-6
  - setStatus
```
public void setStatus(Status status)
```
    Sets the status of the event.
    
    Valid event status codes are:
    - TENTATIVE
    - CONFIRMED
    - CANCELLED
    Parameters:
    status - the status or null to remove
    See Also:
    RFC 5545 p.92-3, RFC 2445 p.88-9, vCal 1.0 p.35-6
  - getSummary
```
public Summary getSummary()
```
    Gets the summary of the event.
    
    Returns:
    the summary or null if not set
    See Also:
    RFC 5545 p.93-4, RFC 2445 p.89-90, vCal 1.0 p.36
  - setSummary
```
public void setSummary(Summary summary)
```
    Sets the summary of the event.
    
    Parameters:
    summary - the summary or null to remove
    See Also:
    RFC 5545 p.93-4, RFC 2445 p.89-90, vCal 1.0 p.36
  - setSummary
```
public Summary setSummary(String summary)
```
    Sets the summary of the event.
    
    Parameters:
    summary - the summary or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.93-4, RFC 2445 p.89-90, vCal 1.0 p.36
  - getTransparency
```
public Transparency getTransparency()
```
    Gets whether an event is visible to free/busy time searches. If the event does not have this property, it should be considered visible ("opaque").
    
    Returns:
    the transparency or null if not set
    See Also:
    RFC 5545 p.101-2, RFC 2445 p.96-7, vCal 1.0 p.36-7
  - setTransparency
```
public void setTransparency(Transparency transparency)
```
    Sets whether an event is visible to free/busy time searches.
    
    Parameters:
    transparency - the transparency or null to remove
    See Also:
    RFC 5545 p.101-2, RFC 2445 p.96-7, vCal 1.0 p.36-7
  - setTransparency
```
public Transparency setTransparency(Boolean transparent)
```
    Sets whether an event is visible to free/busy time searches.
    
    Parameters:
    transparent - true to hide the event, false to make it visible it, or null to remove the property
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.101-2, RFC 2445 p.96-7, vCal 1.0 p.36-7
  - getOrganizer
```
public Organizer getOrganizer()
```
    Gets the organizer of the event.
    
    Returns:
    the organizer or null if not set
    See Also:
    RFC 5545 p.111-2, RFC 2445 p.106-7
  - setOrganizer
```
public void setOrganizer(Organizer organizer)
```
    Sets the organizer of the event.
    
    Parameters:
    organizer - the organizer or null to remove
    See Also:
    RFC 5545 p.111-2, RFC 2445 p.106-7
  - setOrganizer
```
public Organizer setOrganizer(String email)
```
    Sets the organizer of the event.
    
    Parameters:
    email - the organizer's email address (e.g. "johndoe@example.com") or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.111-2, RFC 2445 p.106-7
  - getRecurrenceId
```
public RecurrenceId getRecurrenceId()
```
    Gets the original value of the DateStart property if the event is recurring and has been modified. Used in conjunction with the Uid and Sequence properties to uniquely identify a recurrence instance.
    
    Returns:
    the recurrence ID or null if not set
    See Also:
    RFC 5545 p.112-4, RFC 2445 p.107-9
  - setRecurrenceId
```
public void setRecurrenceId(RecurrenceId recurrenceId)
```
    Sets the original value of the DateStart property if the event is recurring and has been modified. Used in conjunction with the Uid and Sequence properties to uniquely identify a recurrence instance.
    
    Parameters:
    recurrenceId - the recurrence ID or null to remove
    See Also:
    RFC 5545 p.112-4, RFC 2445 p.107-9
  - setRecurrenceId
```
public RecurrenceId setRecurrenceId(Date originalStartDate)
```
    Sets the original value of the DateStart property if the event is recurring and has been modified. Used in conjunction with the Uid and Sequence properties to uniquely identify a recurrence instance.
    
    Parameters:
    originalStartDate - the original start date or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.112-4, RFC 2445 p.107-9
  - getUrl
```
public Url getUrl()
```
    Gets a URL to a resource that contains additional information about the event.
    
    Returns:
    the URL or null if not set
    See Also:
    RFC 5545 p.116-7, RFC 2445 p.110-1, vCal 1.0 p.37
  - setUrl
```
public void setUrl(Url url)
```
    Sets a URL to a resource that contains additional information about the event.
    
    Parameters:
    url - the URL or null to remove
    See Also:
    RFC 5545 p.116-7, RFC 2445 p.110-1, vCal 1.0 p.37
  - setUrl
```
public Url setUrl(String url)
```
    Sets a URL to a resource that contains additional information about the event.
    
    Parameters:
    url - the URL (e.g. "http://example.com/resource.ics") or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.116-7, RFC 2445 p.110-1, vCal 1.0 p.37
  - getRecurrenceRule
```
public RecurrenceRule getRecurrenceRule()
```
    Gets how often the event repeats.
    
    Returns:
    the recurrence rule or null if not set
    See Also:
    RFC 5545 p.122-32, RFC 2445 p.117-25, vCal 1.0 p.34
  - setRecurrenceRule
```
public RecurrenceRule setRecurrenceRule(Recurrence recur)
```
    Sets how often the event repeats.
    
    Parameters:
    recur - the recurrence rule or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.122-32, RFC 2445 p.117-25, vCal 1.0 p.34
  - setRecurrenceRule
```
public void setRecurrenceRule(RecurrenceRule recurrenceRule)
```
    Sets how often the event repeats.
    
    Parameters:
    recurrenceRule - the recurrence rule or null to remove
    See Also:
    RFC 5545 p.122-32, RFC 2445 p.117-25, vCal 1.0 p.34
  - getDateEnd
```
public DateEnd getDateEnd()
```
    Gets the date that the event ends.
    
    Returns:
    the end date or null if not set
    See Also:
    RFC 5545 p.95-6, RFC 2445 p.91-2, vCal 1.0 p.31
  - setDateEnd
```
public void setDateEnd(DateEnd dateEnd)
```
    Sets the date that the event ends. This must NOT be set if a DurationProperty is defined.
    
    Parameters:
    dateEnd - the end date or null to remove
    See Also:
    RFC 5545 p.95-6, RFC 2445 p.91-2, vCal 1.0 p.31
  - setDateEnd
```
public DateEnd setDateEnd(Date dateEnd)
```
    Sets the date that the event ends. This must NOT be set if a DurationProperty is defined.
    
    Parameters:
    dateEnd - the end date or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.95-6, RFC 2445 p.91-2, vCal 1.0 p.31
  - setDateEnd
```
public DateEnd setDateEnd(Date dateEnd,
                 boolean hasTime)
```
    Sets the date that the event ends. This must NOT be set if a DurationProperty is defined.
    
    Parameters:
    dateEnd - the end date or null to remove
    hasTime - true if the date has a time component, false if it is strictly a date (if false, the given Date object should be created by a Calendar object that uses the JVM's default timezone)
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.95-6, RFC 2445 p.91-2, vCal 1.0 p.31
  - getDuration
```
public DurationProperty getDuration()
```
    Gets the duration of the event.
    
    Returns:
    the duration or null if not set
    See Also:
    RFC 5545 p.99, RFC 2445 p.94-5
  - setDuration
```
public void setDuration(DurationProperty duration)
```
    Sets the duration of the event. This must NOT be set if a DateEnd is defined.
    
    Parameters:
    duration - the duration or null to remove
    See Also:
    RFC 5545 p.99, RFC 2445 p.94-5
  - setDuration
```
public DurationProperty setDuration(Duration duration)
```
    Sets the duration of the event. This must NOT be set if a DateEnd is defined.
    
    Parameters:
    duration - the duration or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.99, RFC 2445 p.94-5
  - getCreated
```
public Created getCreated()
```
    Gets the date-time that the event was initially created.
    
    Returns:
    the creation date-time or null if not set
    See Also:
    RFC 5545 p.136, RFC 2445 p.129-30, vCal 1.0 p.29
  - setCreated
```
public void setCreated(Created created)
```
    Sets the date-time that the event was initially created.
    
    Parameters:
    created - the creation date-time or null to remove
    See Also:
    RFC 5545 p.136, RFC 2445 p.129-30, vCal 1.0 p.29
  - setCreated
```
public Created setCreated(Date created)
```
    Sets the date-time that the event was initially created.
    
    Parameters:
    created - the creation date-time or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.136, RFC 2445 p.129-30, vCal 1.0 p.29
  - getLastModified
```
public LastModified getLastModified()
```
    Gets the date-time that the event was last changed.
    
    Returns:
    the last modified date or null if not set
    See Also:
    RFC 5545 p.138, RFC 2445 p.131, vCal 1.0 p.31
  - setLastModified
```
public void setLastModified(LastModified lastModified)
```
    Sets the date-time that event was last changed.
    
    Parameters:
    lastModified - the last modified date or null to remove
    See Also:
    RFC 5545 p.138, RFC 2445 p.131, vCal 1.0 p.31
  - setLastModified
```
public LastModified setLastModified(Date lastModified)
```
    Sets the date-time that the event was last changed.
    
    Parameters:
    lastModified - the last modified date or null to remove
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.138, RFC 2445 p.131, vCal 1.0 p.31
  - getSequence
```
public Sequence getSequence()
```
    Gets the revision number of the event. The organizer can increment this number every time he or she makes a significant change.
    
    Returns:
    the sequence number
    See Also:
    RFC 5545 p.138-9, RFC 2445 p.131-3, vCal 1.0 p.35
  - setSequence
```
public void setSequence(Sequence sequence)
```
    Sets the revision number of the event. The organizer can increment this number every time he or she makes a significant change.
    
    Parameters:
    sequence - the sequence number
    See Also:
    RFC 5545 p.138-9, RFC 2445 p.131-3, vCal 1.0 p.35
  - setSequence
```
public Sequence setSequence(Integer sequence)
```
    Sets the revision number of the event. The organizer can increment this number every time he or she makes a significant change.
    
    Parameters:
    sequence - the sequence number
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.138-9, RFC 2445 p.131-3, vCal 1.0 p.35
  - incrementSequence
```
public void incrementSequence()
```
    Increments the revision number of the event. The organizer can increment this number every time he or she makes a significant change.
    
    See Also:
    RFC 5545 p.138-9, RFC 2445 p.131-3, vCal 1.0 p.35
  - getAttachments
```
public List<Attachment> getAttachments()
```
    Gets any attachments that are associated with the event.
    
    Returns:
    the attachments (any changes made this list will affect the parent component object and vice versa)
    See Also:
    RFC 5545 p.80-1, RFC 2445 p.77-8, vCal 1.0 p.25
  - addAttachment
```
public void addAttachment(Attachment attachment)
```
    Adds an attachment to the event.
    
    Parameters:
    attachment - the attachment to add
    See Also:
    RFC 5545 p.80-1, RFC 2445 p.77-8, vCal 1.0 p.25
  - getAttendees
```
public List<Attendee> getAttendees()
```
    Gets the people who are attending the event.
    
    Returns:
    the attendees (any changes made this list will affect the parent component object and vice versa)
    See Also:
    RFC 5545 p.107-9, RFC 2445 p.102-4, vCal 1.0 p.25-7
  - addAttendee
```
public void addAttendee(Attendee attendee)
```
    Adds a person who is attending the event.
    
    Parameters:
    attendee - the attendee
    See Also:
    RFC 5545 p.107-9, RFC 2445 p.102-4, vCal 1.0 p.25-7
  - addAttendee
```
public Attendee addAttendee(String email)
```
    Adds a person who is attending the event.
    
    Parameters:
    email - the attendee's email address
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.107-9, RFC 2445 p.102-4, vCal 1.0 p.25-7
  - getCategories
```
public List<Categories> getCategories()
```
    Gets a list of "tags" or "keywords" that describe the event.
    
    Returns:
    the categories (any changes made this list will affect the parent component object and vice versa)
    See Also:
    RFC 5545 p.81-2, RFC 2445 p.78-9, vCal 1.0 p.28
  - addCategories
```
public void addCategories(Categories categories)
```
    Adds a list of "tags" or "keywords" that describe the event. Note that a single property can hold multiple keywords.
    
    Parameters:
    categories - the categories to add
    See Also:
    RFC 5545 p.81-2, RFC 2445 p.78-9, vCal 1.0 p.28
  - addCategories
```
public Categories addCategories(String... categories)
```
    Adds a list of "tags" or "keywords" that describe the event.
    
    Parameters:
    categories - the categories to add
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.81-2, RFC 2445 p.78-9, vCal 1.0 p.28
  - addCategories
```
public Categories addCategories(List<String> categories)
```
    Adds a list of "tags" or "keywords" that describe the event.
    
    Parameters:
    categories - the categories to add
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.81-2, RFC 2445 p.78-9, vCal 1.0 p.28
  - getComments
```
public List<Comment> getComments()
```
    Gets the comments attached to the event.
    
    Returns:
    the comments (any changes made this list will affect the parent component object and vice versa)
    See Also:
    RFC 5545 p.83-4, RFC 2445 p.80-1
  - addComment
```
public void addComment(Comment comment)
```
    Adds a comment to the event.
    
    Parameters:
    comment - the comment to add
    See Also:
    RFC 5545 p.83-4, RFC 2445 p.80-1
  - addComment
```
public Comment addComment(String comment)
```
    Adds a comment to the event.
    
    Parameters:
    comment - the comment to add
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.83-4, RFC 2445 p.80-1
  - getContacts
```
public List<Contact> getContacts()
```
    Gets the contacts associated with the event.
    
    Returns:
    the contacts (any changes made this list will affect the parent component object and vice versa)
    See Also:
    RFC 5545 p.109-11, RFC 2445 p.104-6
  - addContact
```
public void addContact(Contact contact)
```
    Adds a contact to the event.
    
    Parameters:
    contact - the contact
    See Also:
    RFC 5545 p.109-11, RFC 2445 p.104-6
  - addContact
```
public Contact addContact(String contact)
```
    Adds a contact to the event.
    
    Parameters:
    contact - the contact (e.g. "ACME Co - (123) 555-1234")
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.109-11, RFC 2445 p.104-6
  - getExceptionDates
```
public List<ExceptionDates> getExceptionDates()
```
    Gets the list of exceptions to the recurrence rule defined in the event (if one is defined).
    
    Returns:
    the list of exceptions (any changes made this list will affect the parent component object and vice versa)
    See Also:
    RFC 5545 p.118-20, RFC 2445 p.112-4, vCal 1.0 p.31
  - addExceptionDates
```
public void addExceptionDates(ExceptionDates exceptionDates)
```
    Adds a list of exceptions to the recurrence rule defined in the event (if one is defined). Note that this property can contain multiple dates.
    
    Parameters:
    exceptionDates - the list of exceptions
    See Also:
    RFC 5545 p.118-20, RFC 2445 p.112-4, vCal 1.0 p.31
  - getRequestStatus
```
public RequestStatus getRequestStatus()
```
    Gets the response to a scheduling request.
    
    Returns:
    the response
    See Also:
    RFC 5546 Section 3.6, RFC 5545 p.141-3, RFC 2445 p.134-6
  - setRequestStatus
```
public void setRequestStatus(RequestStatus requestStatus)
```
    Sets the response to a scheduling request.
    
    Parameters:
    requestStatus - the response
    See Also:
    RFC 5546 Section 3.6, RFC 5545 p.141-3, RFC 2445 p.134-6
  - getRelatedTo
```
public List<RelatedTo> getRelatedTo()
```
    Gets the components that the event is related to.
    
    Returns:
    the relationships (any changes made this list will affect the parent component object and vice versa)
    See Also:
    RFC 5545 p.115-6, RFC 2445 p.109-10, vCal 1.0 p.33-4
  - addRelatedTo
```
public void addRelatedTo(RelatedTo relatedTo)
```
    Adds a component that the event is related to.
    
    Parameters:
    relatedTo - the relationship
    See Also:
    RFC 5545 p.115-6, RFC 2445 p.109-10, vCal 1.0 p.33-4
  - addRelatedTo
```
public RelatedTo addRelatedTo(String uid)
```
    Adds a component that the event is related to.
    
    Parameters:
    uid - the UID of the other component
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.115-6, RFC 2445 p.109-10, vCal 1.0 p.33-4
  - getResources
```
public List<Resources> getResources()
```
    Gets the resources that are needed for the event.
    
    Returns:
    the resources (any changes made this list will affect the parent component object and vice versa)
    See Also:
    RFC 5545 p.91, RFC 2445 p.87-8, vCal 1.0 p.34-5
  - addResources
```
public void addResources(Resources resources)
```
    Adds a list of resources that are needed for the event. Note that a single property can hold multiple resources.
    
    Parameters:
    resources - the resources to add
    See Also:
    RFC 5545 p.91, RFC 2445 p.87-8, vCal 1.0 p.34-5
  - addResources
```
public Resources addResources(String... resources)
```
    Adds a list of resources that are needed for the event.
    
    Parameters:
    resources - the resources to add (e.g. "easel", "projector")
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.91, RFC 2445 p.87-8, vCal 1.0 p.34-5
  - addResources
```
public Resources addResources(List<String> resources)
```
    Adds a list of resources that are needed for the event.
    
    Parameters:
    resources - the resources to add (e.g. "easel", "projector")
    
    Returns:
    the property that was created
    See Also:
    RFC 5545 p.91, RFC 2445 p.87-8, vCal 1.0 p.34-5
  - getRecurrenceDates
```
public List<RecurrenceDates> getRecurrenceDates()
```
    Gets the list of dates/periods that help define the recurrence rule of this event (if one is defined).
    
    Returns:
    the recurrence dates (any changes made this list will affect the parent component object and vice versa)
    See Also:
    RFC 5545 p.120-2, RFC 2445 p.115-7, vCal 1.0 p.34
  - addRecurrenceDates
```
public void addRecurrenceDates(RecurrenceDates recurrenceDates)
```
    Adds a list of dates/periods that help define the recurrence rule of this event (if one is defined).
    
    Parameters:
    recurrenceDates - the recurrence dates
    See Also:
    RFC 5545 p.120-2, RFC 2445 p.115-7, vCal 1.0 p.34
  - getAlarms
```
public List<VAlarm> getAlarms()
```
    Gets the alarms that are assigned to this event.
    
    Returns:
    the alarms (any changes made this list will affect the parent component object and vice versa)
    See Also:
    RFC 5545 p.71-6, RFC 2445 p.67-73
  - addAlarm
```
public void addAlarm(VAlarm alarm)
```
    Adds an alarm to this event.
    
    Parameters:
    alarm - the alarm
    See Also:
    RFC 5545 p.71-6, RFC 2445 p.67-73
  - getExceptionRules
```
public List<ExceptionRule> getExceptionRules()
```
    Gets the exceptions for the RecurrenceRule property.
    
    Note that this property has been removed from the latest version of the iCal specification. Its use should be avoided.
    
    Returns:
    the exception rules (any changes made this list will affect the parent component object and vice versa)
    See Also:
    RFC 2445 p.114-15, vCal 1.0 p.31
  - addExceptionRule
```
public ExceptionRule addExceptionRule(Recurrence recur)
```
    Adds an exception for the RecurrenceRule property.
    
    Note that this property has been removed from the latest version of the iCal specification. Its use should be avoided.
    
    Parameters:
    recur - the exception rule to add
    
    Returns:
    the property that was created
    See Also:
    RFC 2445 p.114-15, vCal 1.0 p.31
  - addExceptionRule
```
public void addExceptionRule(ExceptionRule exceptionRule)
```
    Adds an exception for the RecurrenceRule property.
    
    Note that this property has been removed from the latest version of the iCal specification. Its use should be avoided.
    
    Parameters:
    exceptionRule - the exception rule to add
    See Also:
    RFC 2445 p.114-15, vCal 1.0 p.31
  - getColor
```
public Color getColor()
```
    Gets the color that clients may use when displaying the event (for example, a background color).
    
    Returns:
    the property or null if not set
    See Also:
    draft-ietf-calext-extensions-01 p.9
  - setColor
```
public void setColor(Color color)
```
    Sets the color that clients may use when displaying the event (for example, a background color).
    
    Parameters:
    color - the property or null to remove
    See Also:
    draft-ietf-calext-extensions-01 p.79
  - setColor
```
public Color setColor(String color)
```
    Sets the color that clients may use when displaying the event (for example, a background color).
    
    Parameters:
    color - the color name (case insensitive) or null to remove. Acceptable values are defined in Section 4.3 of the CSS Color Module Level 3 Recommendation. For example, "aliceblue", "green", "navy".
    
    Returns:
    the property object that was created
    See Also:
    draft-ietf-calext-extensions-01 p.9
  - getImages
```
public List<Image> getImages()
```
    Gets the images that are associated with the event.
    
    Returns:
    the images (any changes made this list will affect the parent component object and vice versa)
    See Also:
    draft-ietf-calext-extensions-01 p.10
  - addImage
```
public void addImage(Image image)
```
    Adds an image that is associated with the event.
    
    Parameters:
    image - the image
    See Also:
    draft-ietf-calext-extensions-01 p.10
  - getConferences
```
public List<Conference> getConferences()
```
    Gets information related to the event's conference system.
    
    Returns:
    the conferences (any changes made this list will affect the parent component object and vice versa)
    See Also:
    draft-ietf-calext-extensions-01 p.11
  - addConference
```
public void addConference(Conference conference)
```
    Adds information related to the event's conference system.
    
    Parameters:
    conference - the conference
    See Also:
    draft-ietf-calext-extensions-01 p.11
  - getDateIterator
```
public DateIterator getDateIterator(TimeZone timezone)
```
    Creates an iterator that computes the dates defined by the RecurrenceRule and RecurrenceDates properties (if present), and excludes those dates which are defined by the ExceptionRule and ExceptionDates properties (if present).
    
    In order for RecurrenceRule and ExceptionRule properties to be included in this iterator, a DateStart property must be defined.
    
    Period values in RecurrenceDates properties are not supported and are ignored.
    
    Parameters:
    timezone - the timezone to iterate in. This is needed in order to adjust for when the iterator passes over a daylight savings boundary. This parameter is ignored if the start date does not have a time component.
    
    Returns:
    the iterator
  - validate
```
protected void validate(List<ICalComponent> components,
            ICalVersion version,
            List<Warning> warnings)
```
    Description copied from class: ICalComponent
    
    Checks the component for data consistency problems or deviations from the spec.
    
    This method should be overridden by child classes that wish to provide validation logic. The default implementation of this method does nothing.
    
    Overrides:
    
    validate in class ICalComponent
    
    Parameters:
    components - the hierarchy of components that the component belongs to
    version - the version to validate against
    warnings - the list to add the warnings to
  - copy
```
public VEvent copy()
```
    Description copied from class: ICalComponent
    
    Creates a deep copy of this component object.
    
    The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.
    
    The child class's copy constructor, if present, MUST invoke the ICalComponent.ICalComponent(ICalComponent) super constructor to ensure that the component's properties and sub-components are copied.
    
    This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the component (such as in the ICalendar class's copy constructor ).
    
    Overrides:
    
    copy in class ICalComponent
    
    Returns:
    the copy

Class VEvent

Field Summary

Fields inherited from class biweekly.component.ICalComponent

Constructor Summary

Method Summary

Methods inherited from class biweekly.component.ICalComponent

Methods inherited from class java.lang.Object

Constructor Detail

VEvent

VEvent

Method Detail

getUid

setUid

setUid

getDateTimeStamp

setDateTimeStamp

setDateTimeStamp

getDateStart

setDateStart

setDateStart

setDateStart

getClassification

setClassification

setClassification

getDescription

setDescription

setDescription

getGeo

setGeo

getLocation

setLocation

setLocation

getPriority

setPriority

setPriority

getStatus

setStatus

getSummary

setSummary

setSummary

getTransparency

setTransparency

setTransparency

getOrganizer

setOrganizer

setOrganizer

getRecurrenceId

setRecurrenceId

setRecurrenceId

getUrl

setUrl

setUrl

getRecurrenceRule

setRecurrenceRule

setRecurrenceRule

getDateEnd

setDateEnd

setDateEnd

setDateEnd

getDuration

setDuration

setDuration

getCreated

setCreated

setCreated

getLastModified

setLastModified

setLastModified

getSequence

setSequence

setSequence

incrementSequence

getAttachments

addAttachment

getAttendees

addAttendee

addAttendee

getCategories

addCategories

addCategories