wtanaka.praya
Class Recipient

java.lang.Object
  |
  +--wtanaka.praya.Recipient

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

LocationRecipient, ResolvedRecipient, YahooRecipient

public abstract class Recipient

extends java.lang.Object

implements java.io.Serializable

Base class for all entities which can receive messages.

Return to or the Praya Homepage

Version:

$Name: $ $Date: 2002/01/16 17:24:34 $

Author:

$Author: wtanaka $

See Also:

Serialized Form

Field Summary

protected Protocol	m_protocol
static int	TYPE_BOOLEAN
static int	TYPE_STRING

Constructor Summary

Recipient(Protocol parent)
Constructor.

Method Summary

boolean	equals(java.lang.Object other)
abstract java.lang.String	getDescription() A short string which describes where something addressed to this recipient will go, assuming that the caller is aware of the context of the recipient.
abstract java.util.Hashtable	getFieldNames() Returns an table of names->field contents of fields for insertion into a field enabled editor.
abstract java.lang.String	getFullDescription() A string which describes where something addressed to this recipient will go.
Protocol	getProtocol()
int	hashCode()
abstract ResolvedRecipient	resolve() The ResolvedRecipient returned by this method is directly usable by the Protocol to send messages, as opposed to this Recipient object which is usable by the end user.
abstract Recipient	withNewFields(java.util.Hashtable newFields) Returns a new recipient with the given fields.

Methods inherited from class java.lang.Object

, clone, finalize, getClass, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

TYPE_STRING

public static final int TYPE_STRING

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN

m_protocol

protected Protocol m_protocol

Constructor Detail

Recipient

public Recipient(Protocol parent)

Constructor.

Method Detail

getProtocol

public Protocol getProtocol()

getDescription

public abstract java.lang.String getDescription()

A short string which describes where something addressed to this recipient will go, assuming that the caller is aware of the context of the recipient. For example, this might reutrn "wtanaka@mili.eu.org" or "#dred"

getFullDescription

public abstract java.lang.String getFullDescription()

A string which describes where something addressed to this recipient will go. For example, this might reutrn "email to wtanaka@mili.eu.org" or "irc #dred"

getFieldNames

public abstract java.util.Hashtable getFieldNames()

Returns an table of names->field contents of fields for insertion into a field enabled editor. For instance, an email might have: "From", "To->wtanaka@mili.eu.org", "Cc", "Bcc", etc. This is a map from string to FilledField

withNewFields

public abstract Recipient withNewFields(java.util.Hashtable newFields)

Returns a new recipient with the given fields.

Parameters:

newFields - this is the map from string to FilledField

resolve

public abstract ResolvedRecipient resolve()
                                   throws CannotResolveException

The ResolvedRecipient returned by this method is directly usable by the Protocol to send messages, as opposed to this Recipient object which is usable by the end user. The ResolvedRecipient does not contain any ambiguity, and its creation involves completing as many of the pre-sending preparation steps as possible. For a more complete description, see ResolvedRecipient.

See Also:

ResolvedRecipient

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object