Top Description Fields Methods
org.aspectj.bridge

public Interface IMessageHolder

extends IMessageHandler
Known Direct Implementers
org.aspectj.bridge.MessageHandler
Imports
java.util.List
Hold and query a collection of messages.

Field Summary

Modifier and TypeField and Description
public static final boolean
EQUAL

value for orGreater parameter

public static final boolean
ORGREATER

value for orGreater parameter

Inherited from org.aspectj.bridge.IMessageHandler:
SYSTEM_ERRSYSTEM_OUTTHROW

Method Summary

Modifier and TypeMethod and Description
public void
clearMessages()

Clear any messages.

public IMessage[]

Returns:

IMessage[] of messages of the right kind, or IMessage.NONE
getMessages(IMessage.Kind
the IMessage.Kind expected, or null for all messages
kind, boolean
if true, also get any greater than the target kind as determined by IMessage.Kind.COMPARATOR
orGreater)

Get all messages or those of a specific kind.

public List<IMessage>

Returns:

unmodifiable List view of underlying collection of IMessage
getUnmodifiableListView()

public boolean

Returns:

true if this holder has any message of this kind, or if orGreater and any message has a greater kind, as determined by IMessage.Kind.COMPARATOR
hasAnyMessage(IMessage.Kind
the IMessage.Kind to check for - accept any if null
kind, boolean
if true, also any greater than the target kind as determined by IMessage.Kind.COMPARATOR
orGreater)

Tell whether this holder has any message of this kind (optionally or greater).

public int

Returns:

number of IMessage held (now) by this holder
numMessages(IMessage.Kind
the IMessage.Kind expected, or null for all messages
kind, boolean
if true, also any greater than the target kind as determined by IMessage.Kind.COMPARATOR
orGreater)

Count the messages currently held by this holder.

Inherited from org.aspectj.bridge.IMessageHandler:
dontIgnorehandleMessageignoreisIgnoring

Field Detail

EQUALback to summary
public static final boolean EQUAL

value for orGreater parameter

ORGREATERback to summary
public static final boolean ORGREATER

value for orGreater parameter

Method Detail

clearMessagesback to summary
public void clearMessages() throws UnsupportedOperationException

Clear any messages.

Exceptions
UnsupportedOperationException:
if message list is read-only
getMessagesback to summary
public IMessage[] getMessages(IMessage.Kind kind, boolean orGreater)

Get all messages or those of a specific kind. Pass null to get all kinds.

Parameters
kind:IMessage.Kind

the IMessage.Kind expected, or null for all messages

orGreater:boolean

if true, also get any greater than the target kind as determined by IMessage.Kind.COMPARATOR

Returns:IMessage[]

IMessage[] of messages of the right kind, or IMessage.NONE

getUnmodifiableListViewback to summary
public List<IMessage> getUnmodifiableListView()
Returns:List<IMessage>

unmodifiable List view of underlying collection of IMessage

hasAnyMessageback to summary
public boolean hasAnyMessage(IMessage.Kind kind, boolean orGreater)

Tell whether this holder has any message of this kind (optionally or greater).

Parameters
kind:IMessage.Kind

the IMessage.Kind to check for - accept any if null

orGreater:boolean

if true, also any greater than the target kind as determined by IMessage.Kind.COMPARATOR

Returns:boolean

true if this holder has any message of this kind, or if orGreater and any message has a greater kind, as determined by IMessage.Kind.COMPARATOR

numMessagesback to summary
public int numMessages(IMessage.Kind kind, boolean orGreater)

Count the messages currently held by this holder. Pass null to get all kinds.

Parameters
kind:IMessage.Kind

the IMessage.Kind expected, or null for all messages

orGreater:boolean

if true, also any greater than the target kind as determined by IMessage.Kind.COMPARATOR

Returns:int

number of IMessage held (now) by this holder