|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.mcdermottroe.exemplar.ui.Message
public final class Message
A class to contain all the localised versions of messages produced by the program. The text of the messages is loaded from a .properties file.
| Constructor Summary | |
|---|---|
private |
Message()
Private constructor to prevent instantiation. |
| Method Summary | |
|---|---|
static String |
ANT_LOCALISATION_ERROR()
Ant localisation error message. |
static String |
ASSERTION_MESSAGE(String reason,
String caller)
The message portion of an assertion thrown from DBC.ASSERT(boolean). |
static String |
ATTEMPTING_TO_PARSE(String file,
String type)
Attempting to parse [file] as [type]. |
static String |
COPYRIGHT()
Format the standard copyright message. |
static String |
DEBUG_CLASS_AND_METHOD(String className,
String methodName)
A class and method name formatted for debugging. |
static String |
DTDLEXER_ILLEGAL_CHARACTER()
Error from the DTD
Lexer indicating that an illegal character was encountered. |
static String |
DTDLEXER_INPUT_NOT_FOUND(String fileName)
The input DTD was not found. |
static String |
DTDLEXER_INVALID_CONDITIONAL_SECTION()
Error from the DTD
Lexer indicating that an invalid conditional section was encountered. |
static String |
DTDLEXER_INVALID_TEXTDECL()
Error from the DTD
Lexer indicating that an illegal character was encountered. |
static String |
DTDLEXER_UNKNOWN_CHARACTER()
Error from the DTD
Lexer indicating that an unknown character was encountered. |
static String |
DTDPARSER_THREW_EXCEPTION()
DTD parsing threw an exception. |
static String |
DTDPE_GARBAGE_AFTER_SYSTEMLITERAL()
Trailing characters were found after a SystemLiteral in a parameter entity declaration. |
static String |
DTDPE_INVALID_PEDECL()
Error indicating that a parameter entity declaration was malformed. |
static String |
DTDPE_INVALID_PUBIDLITERAL()
Error indicating that a PubidLiteral was malformed. |
static String |
DTDPE_INVALID_SYSTEMLITERAL()
Error indicating that a SystemLiteral was malformed. |
static String |
DTDPE_UNDECLARED_PE(String peName)
A reference to an undeclared parameter entity literal was encountered. |
static String |
DTDPE_UNRESOLVED_PE_REF()
A reference to a parameter entity could not be resolved. |
static String |
DTDPEDECLTABLE(int peDecl,
int uriPeDecl)
Format for PEDeclTable.toString(). |
static String |
DTDPEEXCEPTION(String s,
String context)
The 2 parameter parameter entity exception. |
static String |
EXCEPTION_NO_MESSAGE()
What to display when an Exception has
no message. |
static String |
FILE_WRITE_FAILED(String filename)
A write to a file failed for some reason. |
static String |
FILE_WRITE_IO_EXCEPTION(String filename)
An IOException occurred when writing to a file. |
static String |
GEN_NO_SUCH_DIRECTORY(String directory)
A non-existant directory was referenced. |
static String |
GENERIC_SECURITY_EXCEPTION(String fieldOrMethod,
String className)
A SecurityException was thrown. |
static String |
IGNORING_ERROR()
Message to say that we are ignoring an error. |
static String |
IGNORING_EXCEPTION()
Message to say that we are ignoring an exception. |
static String |
LANGUAGE_DTD()
The XML DTD language. |
static String |
LANGUAGE_JAVA()
The Java language. |
static String |
LANGUAGE_XSLT()
The XSLT language. |
static String |
LEXEREXCEPTION(String s,
String context)
The message formatter for a LexerException. |
static String |
LOCALISATION_ERROR(String s)
A localisation error occurred. |
static void |
localise()
Set the appropriate options to ensure that the program is set up for the current locale and read the messages from the appropriate properties file. |
static String |
MALFORMED_CHAR_REF(CharSequence malformedReference)
A malformed character reference was encountered. |
static String |
MANDATORY_OPTIONS_NOT_SET()
Warning that mandatory options were not set. |
static String |
MESSAGE_EXTRA_BUNDLE_ENTRY(String entryName,
String thisClass)
There's an entry in the messages properties file which has no corresponding field in this class. |
static String |
MESSAGE_MISSING(String s)
Report that a message is missing from the message properties file. |
static String |
MISSING_MANDATORY_OPTION(String optionName)
Tell the user which mandatory option is missing. |
static String |
OPTION_DEFAULT(String defaultValue)
Tell the user the default value of an option. |
static String |
OPTION_ENUM_ARGS_HEADER()
The String printed before the legal options for an Enum are enumerated for the user. |
static String |
OPTION_IS_MANDATORY()
A message to inform the user that the option is mandatory. |
static String |
OPTION_LANGUAGE_OF_API(String language)
Tell the user what languages an API may be used with. |
static String |
OPTION_LANGUAGE_REQUIRES_API()
A message to inform the user that an API must be selected when using a particular language. |
static String |
OPTIONS_INITIALISING()
Initialising options... |
static String |
OPTIONS_NO_SUCH_OPTION(String optionName)
The user attempted to use an option which doesn't exist. |
static String |
SOURCE_GENERATOR_DOCTYPE_NULL()
Someone passed a null doctype to OutputUtils.generateParser(
com.mcdermottroe.exemplar.model.XMLDocumentType,
String, String, String). |
static String |
SOURCE_GENERATOR_LANGUAGE_NULL()
Someone passed a null language to OutputUtils.generateParser(
com.mcdermottroe.exemplar.model.XMLDocumentType,
String, String, String). |
static String |
SOURCE_GENERATOR_THREW_EXCEPTION()
A parser generator threw an exception. |
static String |
UI_PROGRESS_DONE()
Progress message "Done". |
static String |
UI_PROGRESS_FAILED_TO_CREATE_OUTPUT()
Progress message in the UI telling the user that the program failed to create any output. |
static String |
UI_PROGRESS_FINISHED_TIME(double time)
Progress message telling the user that the program has completed and provides the amount of time that the program took. |
static String |
UI_PROGRESS_GENERATING_PARSER()
Progress message in the UI telling the user that the output parser is being generated. |
static String |
UI_PROGRESS_INPUT_PARSE_FAILED()
Progress message in the UI telling the user that the parsing of the input file failed. |
static String |
UI_PROGRESS_OPTIONS()
Progress message in the UI telling the user that the program is currently processing the options. |
static String |
UI_PROGRESS_PARSING_INPUT(String inputFileName)
Progress message telling the user that the program is parsing the input. |
static String |
UNREACHABLE_CODE_REACHED()
Unreachable code has been reached. |
static String |
UNSUPPORTED_INPUT_TYPE()
Unsupported input type. |
static String |
UNTERMINATED_REF()
Unterminated character reference. |
static String |
XMLDOCTYPE_ORPHAN_ATTLIST(String attlist)
Attribute list without an element. |
static String |
XMLDOCTYPE_UNSUPPORTED_FEATURE()
Unsupported feature. |
static String |
XMLDOCTYPE_XMLOBJECT_IN_MARKUPDECLS(String xmlObject)
Forbidden XMLObject in the list
of markup declarations. |
static String |
XMLOBJECT_NOT_CONFIGURED()
XMLObject not configured. |
static String |
XMLPARSER_LOAD_CODE_FRAGMENT_FAILED()
XMLParserSourceGenerator
failed to load a code fragment. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
private static String ANT_LOCALISATION_ERROR
private static String ASSERTION_MESSAGE_MESSAGE_FORMAT
MessageFormat string for ASSERTION_MESSAGE(String, String).
private static String ATTEMPTING_TO_PARSE_MESSAGE_FORMAT
private static String DEBUG_CLASS_AND_METHOD_MESSAGE_FORMAT
MessageFormat string for DEBUG_CLASS_AND_METHOD(String, String).
private static String DTDLEXER_ILLEGAL_CHARACTER
DTD
Lexer indicating that an illegal character was encountered.
private static String DTDLEXER_INPUT_NOT_FOUND_MESSAGE_FORMAT
MessageFormat string for DTDLEXER_INPUT_NOT_FOUND(String).
private static String DTDLEXER_INVALID_CONDITIONAL_SECTION
DTD
Lexer indicating that an invalid conditional section was encountered.
private static String DTDLEXER_INVALID_TEXTDECL
DTD
Lexer indicating that an illegal character was encountered.
private static String DTDLEXER_UNKNOWN_CHARACTER
DTD
Lexer indicating that an unknown character was encountered.
private static String DTDPARSER_THREW_EXCEPTION
private static String DTDPEDECLTABLE_MESSAGE_FORMAT
MessageFormat string for DTDPEDECLTABLE(int,
int).
private static String DTDPEEXCEPTION_MESSAGE_FORMAT
MessageFormat string for DTDPEEXCEPTION(String, String).
private static String DTDPE_GARBAGE_AFTER_SYSTEMLITERAL
private static String DTDPE_INVALID_PEDECL
private static String DTDPE_INVALID_PUBIDLITERAL
private static String DTDPE_INVALID_SYSTEMLITERAL
private static String DTDPE_UNDECLARED_PE_MESSAGE_FORMAT
MessageFormat string for DTDPE_UNDECLARED_PE(String).
private static String DTDPE_UNRESOLVED_PE_REF
private static String EXCEPTION_NO_MESSAGE
Exception has
no message.
private static String FILE_WRITE_FAILED_MESSAGE_FORMAT
MessageFormat string for FILE_WRITE_FAILED(String).
private static String FILE_WRITE_IO_EXCEPTION_MESSAGE_FORMAT
MessageFormat string for FILE_WRITE_IO_EXCEPTION(String).
private static String GENERIC_SECURITY_EXCEPTION_MESSAGE_FORMAT
MessageFormat string for GENERIC_SECURITY_EXCEPTION(String, String).
private static String GEN_NO_SUCH_DIRECTORY_MESSAGE_FORMAT
MessageFormat string for GEN_NO_SUCH_DIRECTORY(String).
private static String IGNORING_ERROR
private static String IGNORING_EXCEPTION
private static String LANGUAGE_DTD
private static String LANGUAGE_JAVA
private static String LANGUAGE_XSLT
private static String LEXEREXCEPTION_MESSAGE_FORMAT
MessageFormat string for LEXEREXCEPTION(String, String).
private static String LOCALISATION_ERROR_MESSAGE_FORMAT
MessageFormat string for LOCALISATION_ERROR(String).
private static String MALFORMED_CHAR_REF_MESSAGE_FORMAT
MessageFormat string for MALFORMED_CHAR_REF(CharSequence).
private static String MANDATORY_OPTIONS_NOT_SET
private static String MESSAGE_EXTRA_BUNDLE_ENTRY_MESSAGE_FORMAT
MessageFormat string for MESSAGE_EXTRA_BUNDLE_ENTRY(String, String).
private static String MESSAGE_MISSING_MESSAGE_FORMAT
MessageFormat string for MESSAGE_MISSING(String).
private static String MISSING_MANDATORY_OPTION_MESSAGE_FORMAT
MessageFormat string for MISSING_MANDATORY_OPTION(String).
private static String OPTION_DEFAULT_MESSAGE_FORMAT
MessageFormat string for OPTION_DEFAULT(String).
private static String OPTION_ENUM_ARGS_HEADER
String printed before the legal options for an Enum
are enumerated for the user.
private static String OPTION_IS_MANDATORY
private static String OPTION_LANGUAGE_OF_API_MESSAGE_FORMAT
MessageFormat string for OPTION_LANGUAGE_OF_API(String).
private static String OPTION_LANGUAGE_REQUIRES_API
private static String OPTIONS_INITIALISING
Options
store.
private static String OPTIONS_NO_SUCH_OPTION_MESSAGE_FORMAT
MessageFormat string for OPTIONS_NO_SUCH_OPTION(String).
private static String SOURCE_GENERATOR_DOCTYPE_NULL
OutputUtils.generateParser(
com.mcdermottroe.exemplar.model.XMLDocumentType, String, String,
String).
private static String SOURCE_GENERATOR_LANGUAGE_NULL
OutputUtils.generateParser(
com.mcdermottroe.exemplar.model.XMLDocumentType, String, String,
String).
private static String SOURCE_GENERATOR_THREW_EXCEPTION
private static String UI_PROGRESS_DONE
private static String UI_PROGRESS_FAILED_TO_CREATE_OUTPUT
private static String UI_PROGRESS_FINISHED_TIME_MESSAGE_FORMAT
MessageFormat string for UI_PROGRESS_FINISHED_TIME(double).
private static String UI_PROGRESS_GENERATING_PARSER
private static String UI_PROGRESS_INPUT_PARSE_FAILED
private static String UI_PROGRESS_OPTIONS
private static String UI_PROGRESS_PARSING_INPUT_MESSAGE_FORMAT
MessageFormat string for UI_PROGRESS_PARSING_INPUT(String).
private static String UNREACHABLE_CODE_REACHED
private static String UNSUPPORTED_INPUT_TYPE
private static String UNTERMINATED_REF
private static String XMLDOCTYPE_ORPHAN_ATTLIST_MESSAGE_FORMAT
MessageFormat string XMLDOCTYPE_ORPHAN_ATTLIST(String).
private static String XMLDOCTYPE_UNSUPPORTED_FEATURE
private static String XMLDOCTYPE_XMLOBJECT_IN_MARKUPDECLS_MESSAGE_FORMAT
MessageFormat string for XMLDOCTYPE_XMLOBJECT_IN_MARKUPDECLS(String).
private static String XMLOBJECT_NOT_CONFIGURED
XMLObject not configured.
private static String XMLPARSER_LOAD_CODE_FRAGMENT_FAILED
XMLParserSourceGenerator failed
to load a code fragment.
| Constructor Detail |
|---|
private Message()
| Method Detail |
|---|
public static String ANT_LOCALISATION_ERROR()
public static String ASSERTION_MESSAGE(String reason,
String caller)
DBC.ASSERT(boolean).
reason - The reason that the assertion was thrown.caller - The place that the assertion was thrown from.
ASSERTION_MESSAGE_MESSAGE_FORMAT.
public static String ATTEMPTING_TO_PARSE(String file,
String type)
file - The file we're attempting to parse.type - The assumed type of the file.
public static String COPYRIGHT()
public static String DEBUG_CLASS_AND_METHOD(String className,
String methodName)
className - The name of the class.methodName - The name of the method.