org.opencms.main.CmsEvent Maven / Gradle / Ivy
Show all versions of opencms-core Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.main;
import java.util.HashMap;
import java.util.Map;
/**
* 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 {@link I_CmsEventListener} interface.
*
* @since 6.0.0
*
* @see I_CmsEventListener
*/
public class CmsEvent {
/** The event data associated with this event. */
private Map m_data;
/** The event type this instance represents. */
private Integer m_type;
/**
* 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
* {@link 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.
*
* @param type event type
* @param data event data
*
* @see I_CmsEventListener
*/
public CmsEvent(int type, Map data) {
m_type = new Integer(type);
m_data = data;
if (m_data == null) {
m_data = new HashMap();
}
}
/**
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (obj instanceof CmsEvent) {
return m_type.equals(((CmsEvent)obj).getTypeInteger());
}
return false;
}
/**
* Provides access to the event data that was passed with this event.
*
* @return the event data of this event
*/
public Map getData() {
return m_data;
}
/**
* Provides access to the event type that was passed with this event.
*
* Event types of the core OpenCms classes are defined in {@link 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.
*
* @return the event type of this event
*
* @see I_CmsEventListener
*/
public int getType() {
return m_type.intValue();
}
/**
* Provides access to the event type as Integer.
*
* @return the event type of this event as Integer
*/
public Integer getTypeInteger() {
return m_type;
}
/**
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return m_type.hashCode();
}
/**
* Return a String representation of this CmsEvent.
*
* @return a String representation of this event
*/
@Override
public String toString() {
return "CmsEvent['" + m_type + "']";
}
}