edu.harvard.hul.ois.jhove

Class Message

java.lang.Object

edu.harvard.hul.ois.jhove.Message

Direct Known Subclasses:

ErrorMessage, InfoMessage

public abstract class Message
extends Object

This class encapsulates a String to be displayed.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	_offset Byte offset to which message applies.
protected String	_subMessage Additional information.
protected JhoveMessage	message PRIVATE INSTANCE FIELDS.
static long	NULL Value indicating a null offset.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Message(JhoveMessage message) Create a Message with an id.
protected	Message(JhoveMessage message, long offset) Create a Message.
protected	Message(JhoveMessage message, String subMessage) Create a Message.
protected	Message(JhoveMessage message, String subMessage, long offset) Create a Message.
protected	Message(String message) Create a Message with an unknown id (for backward compatibility).
protected	Message(String message, long offset) Create a Message.
protected	Message(String message, String subMessage) Create a Message.
protected	Message(String message, String subMessage, long offset) Create a Message.

Method Summary

Modifier and Type	Method and Description
String	getId()
JhoveMessage	getJhoveMessage()
String	getMessage() Get the message string.
long	getOffset() Return the offset to which the information is related.
String	getPrefix()
String	getSubMessage() Get the submessage string.

Methods inherited from class java.lang.Object

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

Field Detail

NULL

public static final long NULL

Value indicating a null offset.

See Also:

Constant Field Values

message

protected final JhoveMessage message

PRIVATE INSTANCE FIELDS.

_subMessage

protected final String _subMessage

Additional information.

_offset

protected final long _offset

Byte offset to which message applies.

Constructor Detail

Message

protected Message(String message)

Create a Message with an unknown id (for backward compatibility). This constructor cannot be invoked directly, since Message is abstract.

Parameters:

message - Human-readable string.

Message

protected Message(JhoveMessage message)

Create a Message with an id. This constructor cannot be invoked directly, since Message is abstract.

Parameters:

id - Unique ID (within the module) for the message

message - Human-readable string.

Message

protected Message(String message,
                  String subMessage)

Create a Message. This constructor cannot be invoked directly, since Message is abstract. The second argument adds secondary details to the primary message; the message will typically be displayed in the form "message:subMessage".

Parameters:

message - Human-readable string.

subMessage - Human-readable additional information.

Message

protected Message(JhoveMessage message,
                  String subMessage)

Create a Message. This constructor cannot be invoked directly, since Message is abstract. The second argument adds secondary details to the primary message; the message will typically be displayed in the form "message:subMessage".

Parameters:

id - Unique ID (within the module) for the message

message - Human-readable string.

subMessage - Human-readable additional information.

Message

protected Message(String message,
                  long offset)

Create a Message. This constructor cannot be invoked directly, since Message is abstract. The second argument adds secondary details to the primary message; the message will typically be displayed in the form "message:subMessage".

Parameters:

message - Human-readable string.

offset - Byte offset associated with the message.

Message

protected Message(JhoveMessage message,
                  long offset)

Create a Message. This constructor cannot be invoked directly, since Message is abstract. The second argument adds secondary details to the primary message; the message will typically be displayed in the form "message:subMessage".

Parameters:

id - Unique ID (within the module) for the message

message - Human-readable string.

offset - Byte offset associated with the message.

Message

protected Message(String message,
                  String subMessage,
                  long offset)

Create a Message. This constructor cannot be invoked directly, since Message is abstract. The second argument adds secondary details to the primary message; the message will typically be displayed in the form "message:subMessage".

Parameters:

message - Human-readable string.

subMessage - Human-readable additional information.

offset - Byte offset associated with the message.

Message

protected Message(JhoveMessage message,
                  String subMessage,
                  long offset)

Create a Message. This constructor cannot be invoked directly, since Message is abstract. The second argument adds secondary details to the primary message; the message will typically be displayed in the form "message:subMessage".

Parameters:

id - Unique ID (within the module) for the message

message - Human-readable string.

subMessage - Human-readable additional information.

offset - Byte offset associated with the message.

Method Detail

getMessage

public String getMessage()

Get the message string.

getSubMessage

public String getSubMessage()

Get the submessage string.

getOffset

public long getOffset()

Return the offset to which the information is related.

getId

public String getId()

getJhoveMessage

public JhoveMessage getJhoveMessage()

getPrefix

public String getPrefix()