public class Organizer extends ICalProperty
This property has different meanings depending on the component it belongs to:
VEvent
- The organizer of the event.VTodo
- The creator of the to-do task.VJournal
- The owner of the journal entry.VFreeBusy
- The person requesting the free/busy time.Code sample:
VEvent event = new VEvent(); Organizer organizer = Organizer.email("johndoe@example.com"); organizer.setCommonName("John Doe"); event.setOrganizer(organizer);
parameters
Constructor and Description |
---|
Organizer(Organizer original)
Copy constructor.
|
Organizer(String name,
String email)
Creates an organizer property
|
Modifier and Type | Method and Description |
---|---|
Organizer |
copy()
Creates a copy of this property object.
|
boolean |
equals(Object obj) |
String |
getCommonName()
Gets the human-readable, display name of the entity represented by this
property.
|
String |
getDirectoryEntry()
Gets a URI that contains additional information about the person.
|
String |
getEmail()
Gets the organizer's email
|
String |
getLanguage()
Gets the language that the common name parameter is written in.
|
String |
getSentBy()
Gets a URI which represents a person who is acting on behalf of the
person that is defined in this property.
|
String |
getUri()
Gets a URI representing the organizer.
|
int |
hashCode() |
void |
setCommonName(String commonName)
Sets the human-readable, display name of the entity represented by this
property.
|
void |
setDirectoryEntry(String directoryEntry)
Sets a URI that contains additional information about the person.
|
void |
setEmail(String email)
Sets the organizer's email
|
void |
setLanguage(String language)
Sets the language that the common name parameter is written in.
|
void |
setSentBy(String sentBy)
Sets a URI which represents a person who is acting on behalf of the
person that is defined in this property.
|
void |
setUri(String uri)
Sets a URI representing the organizer.
|
protected Map<String,Object> |
toStringValues()
Gets string representations of the class's fields for the
ICalProperty.toString() method. |
addParameter, getParameter, getParameters, getParameters, removeParameter, setParameter, setParameter, setParameters, toString, validate, validate
public Organizer(String name, String email)
name
- the organizer's name (e.g. "John Doe")email
- the organizer's email address (e.g. "jdoe@example.com")public String getEmail()
public void setEmail(String email)
email
- the email (e.g. "jdoe@company.com")public String getUri()
public void setUri(String uri)
uri
- the URI (e.g. "mailto:jdoe@company.com")public String getSentBy()
ICalProperty
Gets a URI which represents a person who is acting on behalf of the person that is defined in this property.
Supported versions: 2.0
public void setSentBy(String sentBy)
ICalProperty
Sets a URI which represents a person who is acting on behalf of the person that is defined in this property.
Supported versions: 2.0
sentBy
- a URI representing the person (typically, an email URI, e.g.
"mailto:janedoe@example.com") or null to removepublic String getCommonName()
ICalProperty
Gets the human-readable, display name of the entity represented by this property.
Supported versions: 2.0
public void setCommonName(String commonName)
ICalProperty
Sets the human-readable, display name of the entity represented by this property.
Supported versions: 2.0
commonName
- the display name (e.g. "John Doe") or null to removepublic String getDirectoryEntry()
ICalProperty
Gets a URI that contains additional information about the person.
Supported versions: 2.0
public void setDirectoryEntry(String directoryEntry)
ICalProperty
Sets a URI that contains additional information about the person.
Supported versions: 2.0
directoryEntry
- the URI (e.g. an LDAP URI) or null to removepublic String getLanguage()
public void setLanguage(String language)
language
- the language (e.g. "en" for English) or null to removeprotected Map<String,Object> toStringValues()
ICalProperty
Gets string representations of the class's fields for the
ICalProperty.toString()
method.
Meant to be overridden by child classes. The default implementation returns an empty map.
toStringValues
in class ICalProperty
public Organizer copy()
ICalProperty
Creates a copy of this property 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
ICalProperty.ICalProperty(ICalProperty)
super constructor to ensure that the
parameters are also 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 property (such as in the
ICalendar class's copy constructor
).
copy
in class ICalProperty
public int hashCode()
hashCode
in class ICalProperty
public boolean equals(Object obj)
equals
in class ICalProperty
Copyright © 2013–2024 Michael Angstadt. All rights reserved.