|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.corona.client.collaboration.event.EventProperty
public class EventProperty
This class represents a single property of a collaboration event.
Constructor Summary | |
---|---|
EventProperty(java.lang.String key)
Creates a new event property definition. |
Method Summary | |
---|---|
void |
addValue(java.lang.String value)
Adds a new value of allowed values of the property. |
int |
compare(java.lang.Object e1,
java.lang.Object e2)
Compares two events. |
boolean |
equals(java.lang.Object o)
Checks if two objects point to the same property. |
java.util.Comparator |
getComparator()
Gets a comparator used to compare two values of the property. |
IFormatter |
getFormatter()
Gets converter of the property value to human readable form. |
java.lang.String |
getKey()
A key under which the property value is kept. |
java.lang.String |
getName()
Gets a human readable form of property name. |
java.lang.String |
getStrValue(org.osgi.service.event.Event evt)
Obtains a human readable string representation of a property from a given event. |
java.lang.Object |
getValue(org.osgi.service.event.Event evt)
Gets value of a property form an event. |
java.util.Set |
getValues()
Gets a set of available predefined values. |
int |
hashCode()
Calculates hash code. |
boolean |
isImportant()
Gets if the property is important, should be displayed in an overview or not. |
void |
setComparator(java.util.Comparator comparator)
Sets a comparator used to compare two values of the property. |
void |
setFormatter(IFormatter formatter)
Sets converter of the property value to human readable form. |
void |
setImportant(boolean important)
Sets if the property is important, should be displayed in an overview or not. |
void |
setName(java.lang.String name)
Sets a human readable form of property name. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EventProperty(java.lang.String key)
key
- The key of the property.Method Detail |
---|
public int compare(java.lang.Object e1, java.lang.Object e2)
compare
in interface java.util.Comparator
e1
- The first event to compare.e2
- The second event to compare.public java.lang.String getStrValue(org.osgi.service.event.Event evt)
evt
- The event from which the property will be taken and converted to string.
public java.lang.Object getValue(org.osgi.service.event.Event evt)
evt
- The event from which the property is to be taken.
public boolean equals(java.lang.Object o)
equals
in interface java.util.Comparator
equals
in class java.lang.Object
o
- An other property.public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String getKey()
public java.util.Comparator getComparator()
public void setComparator(java.util.Comparator comparator)
comparator
- the comparator to setpublic IFormatter getFormatter()
public void setFormatter(IFormatter formatter)
formatter
- The formatter to set;
if null, toString() will be used.public java.lang.String getName()
public void setName(java.lang.String name)
name
- the name to setpublic void setImportant(boolean important)
important
- Value if important (true) or not (false).public boolean isImportant()
public java.util.Set getValues()
public void addValue(java.lang.String value)
value
- The new value.
|
Copyright 2006 IBM Corporation and others. All Rights Reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |