message
Class MessageBoxKey

java.lang.Object
  message.MessageBoxKey

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class MessageBoxKey

extends java.lang.Object

implements java.lang.Comparable, java.io.Serializable

This is the identifier for a message box. A box must have at least a name. If the box is meant to be private to a particular portlet (like a PORTLET_SCOPE portlet session attribute), the namespace should be the portlet id and 'local' should be set to true, for the dynamic message wiring tools to work properly.

See Also:

Serialized Form

Field Summary

protected boolean	local
protected java.lang.String	name
protected java.lang.String	namespace

Constructor Summary

MessageBoxKey(java.lang.String name)

MessageBoxKey(java.lang.String name, java.lang.String namespace)

MessageBoxKey(java.lang.String name, java.lang.String namespace, boolean local)

Method Summary

int	compareTo(java.lang.Object o)
boolean	equals(java.lang.Object obj)
java.lang.String	formString()
java.lang.String	getName()
java.lang.String	getNamespace()
int	hashCode()
boolean	isLocal()
static MessageBoxKey	parseFormString(java.lang.String s)
protected void	setLocalNamespace(java.lang.String namespace)
void	setName(java.lang.String name)
void	setNamespace(java.lang.String namespace)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

namespace

protected java.lang.String namespace

local

protected boolean local

Constructor Detail

MessageBoxKey

public MessageBoxKey(java.lang.String name)

MessageBoxKey

public MessageBoxKey(java.lang.String name,
                     java.lang.String namespace)

MessageBoxKey

public MessageBoxKey(java.lang.String name,
                     java.lang.String namespace,
                     boolean local)

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getNamespace

public java.lang.String getNamespace()

setNamespace

public void setNamespace(java.lang.String namespace)

setLocalNamespace

protected void setLocalNamespace(java.lang.String namespace)

isLocal

public boolean isLocal()

equals

public boolean equals(java.lang.Object obj)

hashCode

public int hashCode()

toString

public java.lang.String toString()

formString

public java.lang.String formString()

parseFormString

public static MessageBoxKey parseFormString(java.lang.String s)

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable