org.eclipse.corona.client.collaboration.event
Class EventProperties

java.lang.Object
  extended by org.eclipse.corona.client.collaboration.event.EventProperties

public class EventProperties
extends java.lang.Object

A class which helps with event properties.


Field Summary
static java.lang.String COMPARATOR_ATTR
          An attribute with comparator class
static java.lang.String FORMATTER_ATTR
          An attribute with to string formatter class
static java.lang.String IMPORTANCE_ATTR
          An attribute with importance value
static java.lang.String KEY_ATTR
          An attribute with key param
static java.lang.String NAME_ATTR
          An attribute with property name
static java.lang.String PROPERTIES_EXTPOINT_ID
          The event properties extension point id
static java.lang.String PROPERTY_ELEM
          An element with property definition.
static java.lang.String SCOPE_ATTR
          An attribute which defines a scope (generic, project, etc) which delivers a property or value.
static java.lang.String SCOPE_GENERIC
          An identifier of scope used by generlic collaboration events.
static java.lang.String VALUE_ATTR
          An element with property values.
static java.lang.String VALUE_ELEM
          An element with property values.
static java.lang.String VALUES_ELEM
          An element with property values.
 
Constructor Summary
EventProperties()
           
 
Method Summary
static EventProperty findProperty(java.lang.String key, EventProperty[] properties)
          Finds a property by a key.
static EventProperty[] getEventProperties()
          Creates an array of all known properties.
static EventProperty[] getEventProperties(java.util.Set scopes)
          Creates an array of properties from given scopes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTIES_EXTPOINT_ID

public static final java.lang.String PROPERTIES_EXTPOINT_ID
The event properties extension point id

See Also:
Constant Field Values

SCOPE_GENERIC

public static final java.lang.String SCOPE_GENERIC
An identifier of scope used by generlic collaboration events.

See Also:
Constant Field Values

PROPERTY_ELEM

public static final java.lang.String PROPERTY_ELEM
An element with property definition.

See Also:
Constant Field Values

KEY_ATTR

public static final java.lang.String KEY_ATTR
An attribute with key param

See Also:
Constant Field Values

SCOPE_ATTR

public static final java.lang.String SCOPE_ATTR
An attribute which defines a scope (generic, project, etc) which delivers a property or value.

See Also:
Constant Field Values

NAME_ATTR

public static final java.lang.String NAME_ATTR
An attribute with property name

See Also:
Constant Field Values

COMPARATOR_ATTR

public static final java.lang.String COMPARATOR_ATTR
An attribute with comparator class

See Also:
Constant Field Values

FORMATTER_ATTR

public static final java.lang.String FORMATTER_ATTR
An attribute with to string formatter class

See Also:
Constant Field Values

IMPORTANCE_ATTR

public static final java.lang.String IMPORTANCE_ATTR
An attribute with importance value

See Also:
Constant Field Values

VALUES_ELEM

public static final java.lang.String VALUES_ELEM
An element with property values.

See Also:
Constant Field Values

VALUE_ELEM

public static final java.lang.String VALUE_ELEM
An element with property values.

See Also:
Constant Field Values

VALUE_ATTR

public static final java.lang.String VALUE_ATTR
An element with property values.

See Also:
Constant Field Values
Constructor Detail

EventProperties

public EventProperties()
Method Detail

getEventProperties

public static EventProperty[] getEventProperties()
Creates an array of all known properties.

Returns:
The array may be empty, but never null.

getEventProperties

public static EventProperty[] getEventProperties(java.util.Set scopes)
Creates an array of properties from given scopes.

Parameters:
scopes - The scope filter - only properties and values from given scopes (generic, project, etc) will be taken. If null no scope filtering.
Returns:
The array may be empty, but never null.

findProperty

public static EventProperty findProperty(java.lang.String key,
                                         EventProperty[] properties)
Finds a property by a key.

Parameters:
key - The property key to be found.
properties - An array of properties to look for.
Returns:
The found property with the key, or null if not found.

Copyright 2006 IBM Corporation and others.
All Rights Reserved.