com.adobe.icomm.assetplacement.model
Class ValidationMessage

java.lang.Object
  com.adobe.icomm.assetplacement.model.ValidationMessage

public class ValidationMessage
extends Object

This class represents a single result from a validation pass by the Validator class.

Constructor Summary

ValidationMessage(String messageId, String message, boolean isError)
Constructor.

ValidationMessage(String messageId, String message, boolean isError, String filePath, int lineNum)
Constructor with file and line number.

Method Summary

String	getFilePath() Retrieve the file path.
boolean	getIsError() Retrieve the severity of this message.
int	getLineNum() Line number within the file relevant to the message, or -1 if not specified or not applicable.
String	getMessage() Retrieve the message.
String	getMessageId() Retrieve the ID of this message.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationMessage

public ValidationMessage(String messageId,
                         String message,
                         boolean isError)

Constructor.

Parameters:

messageId - message id

message - the message

isError - true if fatal error, false if informative

ValidationMessage

public ValidationMessage(String messageId,
                         String message,
                         boolean isError,
                         String filePath,
                         int lineNum)

Constructor with file and line number.

Parameters:

messageId - descriptive message

message - the message

isError - true if fatal error, false if informative

filePath - full OS path to the affected file

lineNum - line number within that file (-1 if not applicable)

Method Detail

getMessage

public String getMessage()

Retrieve the message.

Returns:

message

getIsError

public boolean getIsError()

Retrieve the severity of this message.

Returns:

true if it's an error, false if not

getMessageId

public String getMessageId()

Retrieve the ID of this message.

Returns:

the message id

getFilePath

public String getFilePath()

Retrieve the file path.

Returns:

the full path to the file, or null if not specified

getLineNum

public int getLineNum()

Line number within the file relevant to the message, or -1 if not specified or not applicable.

Returns:

line number