org.opencms.main

类 CmsEvent

java.lang.Object

org.opencms.main.CmsEvent

public class CmsEvent
extends java.lang.Object

Event class for OpenCms for system wide events that are thrown by various operations (e.g. publishing) and can be caught and processed by classes that implement the I_CmsEventListener interface.

从以下版本开始:

6.0.0

另请参阅:

I_CmsEventListener

构造器概要

构造器

构造器和说明
CmsEvent(int type, java.util.Map<java.lang.String,java.lang.Object> data) Construct a new CmsEvent with the specified parameters.

方法概要

方法

限定符和类型	方法和说明
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.Object>	getData() Provides access to the event data that was passed with this event.
int	getType() Provides access to the event type that was passed with this event.
java.lang.Integer	getTypeInteger() Provides access to the event type as Integer.
int	hashCode()
java.lang.String	toString() Return a String representation of this CmsEvent.

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

CmsEvent

public CmsEvent(int type,
        java.util.Map<java.lang.String,java.lang.Object> data)

Construct a new CmsEvent with the specified parameters.

The event data Map provides a facility to pass objects with the event that contain information about the event environment. For example, if the event is of type I_CmsEventListener.EVENT_LOGIN_USER the Map contains a single object with the key "data" and a value that is the OpenCms user object that represents the user that just logged in.

参数:

type - event type

data - event data

另请参阅:

I_CmsEventListener

方法详细资料

equals

public boolean equals(java.lang.Object obj)

覆盖:

equals 在类中 java.lang.Object

另请参阅:

Object.equals(java.lang.Object)

getData

public java.util.Map<java.lang.String,java.lang.Object> getData()

Provides access to the event data that was passed with this event.

返回:

the event data of this event

getType

public int getType()

Provides access to the event type that was passed with this event.

Event types of the core OpenCms classes are defined in I_CmsEventListener. For your extensions, you should define them in a central class or interface as public member variables. Make sure the integer values do not conflict with the values from the core classes.

返回:

the event type of this event

另请参阅:

I_CmsEventListener

getTypeInteger

public java.lang.Integer getTypeInteger()

Provides access to the event type as Integer.

返回:

the event type of this event as Integer

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

另请参阅:

Object.hashCode()

toString

public java.lang.String toString()

Return a String representation of this CmsEvent.

覆盖:

toString 在类中 java.lang.Object

返回:

a String representation of this event