com.whitepages.proapi.data.message

Class Message

java.lang.Object

com.whitepages.proapi.data.message.Message

public class Message
extends java.lang.Object

Messages are generated as a result of requests to the API and contain both a message body and meta data about that message.

Messages are found on the Response via the Response.getResponseMessages() accessor method.

Messages have a number of meta-data properties, including:

• Severity: the severity of the message,
• Type: the machine readable categorization of the message,,
• Code: An optional machine readable sub-categorization coding of the message, and
• Ancillary Data: An optional weakly-typed Map of data specific to the message.

See Also:

Response, ResponseMessages

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.Code The secondary machine readable categorization of messages.
static class	Message.MessageType The primary machine readable categorization of messages.
static class	Message.Severity The message severity.

Constructor Summary

Constructors

Constructor and Description
Message(Message.Severity severity, Message.MessageType type, Message.Code code, java.lang.String message)
Message(Message.Severity severity, Message.MessageType type, Message.Code code, java.lang.String message, java.util.Map<java.lang.String,java.lang.Object> ancillaryData)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAncillaryData() Returns the context dependent ancillary data for this message, if any exists.
Message.Code	getCode() Returns the optional secondary machine readable message categorization.
java.lang.String	getMessage() Returns the human readable body text of the message.
Message.Severity	getSeverity() Returns the message severity.
Message.MessageType	getType() Returns the primary machine readable message categorization.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message(Message.Severity severity,
       Message.MessageType type,
       Message.Code code,
       java.lang.String message)

Message

public Message(Message.Severity severity,
       Message.MessageType type,
       Message.Code code,
       java.lang.String message,
       java.util.Map<java.lang.String,java.lang.Object> ancillaryData)

Method Detail

getSeverity

public Message.Severity getSeverity()

Returns the message severity.

Returns:

The message severity.

getType

public Message.MessageType getType()

Returns the primary machine readable message categorization.

Returns:

The message type.

getCode

public Message.Code getCode()

Returns the optional secondary machine readable message categorization.

Returns:

The message code.

getMessage

public java.lang.String getMessage()

Returns the human readable body text of the message.

Returns:

The message body.

getAncillaryData

public java.util.Map<java.lang.String,java.lang.Object> getAncillaryData()

Returns the context dependent ancillary data for this message, if any exists.

Most messages do not contain any ancillary data; however the occasional message does have extra data associated with it. While the keys present, and the types for the values, will vary between message types, for any given message type these properties can be expected to stay consistent.

Returns:

The ancillary data hash.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object