org.wicketstuff.chat.channel.api.ChannelEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wicket-chat-api Show documentation

This project holds interfaces for the chat communication. Inspired from the wicketstuff push project. Many interfaces are took from the wicketstuff push project.

The newest version!

/**
 * Copyright (C) 2015 Asterios Raptis
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.wicketstuff.chat.channel.api;

import java.util.HashMap;
import java.util.Map;

/**
 * A event containing data to send by server pushing. This event has to be published by
 * {@link IChannelPublisher} instance.
 * 
 * a pushEvent is specific of a channel represented by a string and can contains some datas to send
 * to the listener.
 * 
 * 
 * 
 * @author Vincent Demay
 * @author Rodolfo Hansen
 */
public class ChannelEvent
{
	private String channel;
	private final Map data;
	private String id = "0";

	/**
	 * Construct.
	 * 
	 * @param channel
	 *            channel where the event will be sent
	 */
	public ChannelEvent(final String channel)
	{
		this.channel = channel;
		data = new HashMap();
	}

	/**
	 * Add a data in the event. This event will be transfered to all the listener of the channel
	 * 
	 * @param key
	 *            data key
	 * @param data
	 *            data to add in the event
	 */
	public void addData(final String key, final String data)
	{
		this.data.put(key, data);
	}

	/**
	 * return the channel of the event
	 * 
	 * @return the channel of the event
	 */
	public String getChannel()
	{
		return channel;
	}

	/**
	 * Returns all data in the event
	 * 
	 * @return all data in the event
	 */
	public Map getData()
	{
		return data;
	}

	public String getId()
	{
		return id;
	}

	/**
	 * set the channel of the event
	 * 
	 * @param channel
	 *            event channel
	 */
	public void setChannel(final String channel)
	{
		this.channel = channel;
	}

	public void setId(final String id)
	{
		this.id = id;
	}

}