jadex.bridge.component.impl.MsgHeader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-platform-bridge Show documentation

Jadex bridge is a base package for kernels and platforms, i.e., it is used by both and provides commonly used interfaces and classes for active components and their management.

There is a newer version: 4.0.267

Show newest version

package jadex.bridge.component.impl;

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

import jadex.bridge.IComponentIdentifier;
import jadex.bridge.component.IMsgHeader;

/**
 *   Message header with message meta information.
 *
 */
public class MsgHeader implements IMsgHeader
{
	
	/** Map containing properties. */
	protected Map properties;
	
	/**
	 *  Creates the header.
	 */
	public MsgHeader()
	{
	}
	
	/**
	 *  Gets the sender of the message.
	 * 
	 *  @return The sender.
	 */
	public IComponentIdentifier getSender()
	{
		return (IComponentIdentifier) getProperty(IMsgHeader.SENDER);
	}
	
	/**
	 *  Gets the receiver of the message.
	 * 
	 *  @return The receiver.
	 */
	public IComponentIdentifier getReceiver()
	{
		return (IComponentIdentifier) getProperty(IMsgHeader.RECEIVER);
	}
	
	/**
	 *  Gets a property stored in the header.
	 *  
	 *  @param propertyname The name of the property.
	 *  @return Property value.
	 */
	public Object getProperty(String propertyname)
	{
		return properties.get(propertyname);
	}

	/**
	 *  Gets the properties.
	 *
	 *  @return The properties map.
	 */
	public Map getProperties()
	{
		return properties;
	}

	/**
	 *  Sets the properties.
	 *
	 *  @param properties The properties map.
	 */
	public void setProperties(Map properties)
	{
		this.properties = properties;
	}
	
	/**
	 *  Adds a header property to the header.
	 *  
	 *  @param propname The property name.
	 *  @param propval The property value.
	 */
	public void addProperty(String propname, Object propval)
	{
		if (properties == null)
			properties = new HashMap();
		properties.put(propname, propval);
	}

	/**
	 *  Get the string rep.
	 */
	public String toString()
	{
		return "MsgHeader(properties=" + properties + ")";
	}
	
}