Package org.osgi.service.event

Class Event

java.lang.Object
org.osgi.service.event.Event
public class Event extends Object
An event. Event objects are delivered to EventHandler services which subscribe to the topic of the event.
Version:
$Revision: 7003 $

  • Constructor Details

    • Event

      public Event(String topic, Map properties)
      Constructs an event.
      Parameters:
      topic - The topic of the event.
      properties - The event's properties (may be null). A property whose key is not of type String will be ignored.
      Throws:
      IllegalArgumentException - If topic is not a valid topic name.
      Since:
      1.2

    • Event

      public Event(String topic, Dictionary properties)
      Constructs an event.
      Parameters:
      topic - The topic of the event.
      properties - The event's properties (may be null). A property whose key is not of type String will be ignored.
      Throws:
      IllegalArgumentException - If topic is not a valid topic name.

  • Method Details

    • getProperty

      public final Object getProperty(String name)
      Retrieves a property.
      Parameters:
      name - the name of the property to retrieve
      Returns:
      The value of the property, or null if not found.

    • getPropertyNames

      public final String[] getPropertyNames()
      Returns a list of this event's property names.
      Returns:
      A non-empty array with one element per property.

    • getTopic

      public final String getTopic()
      Returns the topic of this event.
      Returns:
      The topic of this event.

    • matches

      public final boolean matches(org.osgi.framework.Filter filter)
      Tests this event's properties against the given filter using a case sensitive match.
      Parameters:
      filter - The filter to test.
      Returns:
      true If this event's properties match the filter, false otherwise.

    • equals

      public boolean equals(Object object)
      Compares this Event object to another object.

      An event is considered to be equal to another event if the topic is equal and the properties are equal.

      Overrides:
      equals in class Object
      Parameters:
      object - The Event object to be compared.
      Returns:
      true if object is a Event and is equal to this object; false otherwise.

    • hashCode

      public int hashCode()
      Returns a hash code value for the object.
      Overrides:
      hashCode in class Object
      Returns:
      An integer which is a hash code value for this object.

    • toString

      public String toString()
      Returns the string representation of this event.
      Overrides:
      toString in class Object
      Returns:
      The string representation of this event.