org.eclipse.jpt.common.core.utility
Interface ValidationMessage

public interface ValidationMessage

A validation message

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Field Summary

static int	IGNORE_SEVERITY Any validation message with this severity will be ignored and no marker produced.
static int	UNSET_SEVERITY_PREFERENCE This value is returned for any validation severity preference that has not been specified.

Method Summary

IMessage	buildValidationMessage(IResource target, TextRange textRange, Object... args) Build a validation message with the specified target resource, text range, and arguments to be bound to the message template.
int	getDefaultSeverity() Return the message's default severity (i.e. the severity of the message in the absence of a user-specified preference).
String	getDescription() Return the message's description.
String	getID() Return the message's ID.
void	setDefaultSeverity(int severity) Set the message's default severity (i.e. the severity of the message in the absence of a user-specified preference).

Field Detail

IGNORE_SEVERITY

static final int IGNORE_SEVERITY

Any validation message with this severity will be ignored and no marker produced.

Value: 8

See Also:

IMessage#getSeverity(), Constant Field Values

UNSET_SEVERITY_PREFERENCE

static final int UNSET_SEVERITY_PREFERENCE

This value is returned for any validation severity preference that has not been specified.

Value: -1

See Also:

IMessage#getSeverity(), Constant Field Values

Method Detail

getID

String getID()

Return the message's ID. This is the name of the static field that holds the message.

getDescription

String getDescription()

Return the message's description.

getDefaultSeverity

int getDefaultSeverity()

Return the message's default severity (i.e. the severity of the message in the absence of a user-specified preference).

See Also:

IMessage#getSeverity()

setDefaultSeverity

void setDefaultSeverity(int severity)

Set the message's default severity (i.e. the severity of the message in the absence of a user-specified preference).

See Also:

IMessage#getSeverity()

buildValidationMessage

IMessage buildValidationMessage(IResource target,
                                TextRange textRange,
                                Object... args)

Build a validation message with the specified target resource, text range, and arguments to be bound to the message template.