com.whitepages.proapi.api.response

Class ResponseMessages

java.lang.Object

com.whitepages.proapi.api.response.ResponseMessages

public class ResponseMessages
extends java.lang.Object

Encapsulates a list of Message instances in order to provide methods for common operations.

See Also:

Response, Message

Constructor Summary

Constructors

Constructor and Description
ResponseMessages(java.util.List<Message> messageList)

Method Summary

Methods

Modifier and Type	Method and Description
Message	get(int index)
java.util.List<Message>	getMessageList() Accessor for retrieving the list of messages.
java.util.List<Message>	getMessageList(Message.Severity severity) Gets the subset of messages of the given severity.
boolean	isEmpty()
java.util.Iterator<Message>	iterator()
java.util.ListIterator<Message>	listIterator()
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseMessages

public ResponseMessages(java.util.List<Message> messageList)

Method Detail

getMessageList

public java.util.List<Message> getMessageList()

Accessor for retrieving the list of messages.

One should prefer using methods on the ResponseMessages object, when availabile. For example, rather than calling
response.getResponseMessages().getMessageList().get(0),
one should call
response.getResponseMessages().get(0).

Returns:

The messages in this collection as a List.

size

public int size()

isEmpty

public boolean isEmpty()

iterator

public java.util.Iterator<Message> iterator()

listIterator

public java.util.ListIterator<Message> listIterator()

get

public Message get(int index)

getMessageList

public java.util.List<Message> getMessageList(Message.Severity severity)

Gets the subset of messages of the given severity.

This method is particularly useful for retrieving the list of error messages. via response.getResponseMessages().getMessageList(Message.Severity.ERROR)

Parameters:

severity - The severity for which to filter.

Returns:

The list of all messages with the given severity.