Package com.xmlmind.util
Class SimpleConsole
- java.lang.Object
-
- com.xmlmind.util.SimpleConsole
-
- All Implemented Interfaces:
Console
public final class SimpleConsole extends Object implements Console
An implementation of Console which prints its messages toSystem.err
andSystem.out
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.xmlmind.util.Console
Console.MessageType
-
-
Field Summary
Fields Modifier and Type Field Description static SimpleConsole
INSTANCE
A ready-to-use instance ofSimpleConsole
-
Constructor Summary
Constructors Constructor Description SimpleConsole()
Equivalent tothis(null, true, MessageType.INFO)
.SimpleConsole(String prefix, boolean showMessageType, Console.MessageType errorLevel)
Constructs aSimpleConsole
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Console.MessageType
getErrorLevel()
Returns the least severe message type displayed by this console.String
getPrefix()
Returns the prefix to be added to the messages displayed by this console; may returnnull
.boolean
isShowingMessageType()
Returnstrue
if the type of the message should be used to prefix the messages displayed by this console;false
otherwise.void
setErrorLevel(Console.MessageType level)
Specifies the least severe message type displayed by this console.void
setPrefix(String prefix)
Specifies the prefix to be added to the messages displayed by this console; may benull
.void
setShowingMessageType(boolean show)
Specifies whether the type of the message should be used to prefix the messages displayed by this console.void
showMessage(String message, Console.MessageType messageType)
Show specified message to user.
-
-
-
Field Detail
-
INSTANCE
public static final SimpleConsole INSTANCE
A ready-to-use instance ofSimpleConsole
-
-
Constructor Detail
-
SimpleConsole
public SimpleConsole()
Equivalent tothis(null, true, MessageType.INFO)
.
-
SimpleConsole
public SimpleConsole(String prefix, boolean showMessageType, Console.MessageType errorLevel)
Constructs aSimpleConsole
.- Parameters:
prefix
- prefix to be added to the messages displayed by this console; may benull
showMessageType
- specifies whether the type of the message should be used to prefix the messages displayed by this consoleerrorLevel
- specifies the least severe message type displayed by this console
-
-
Method Detail
-
setPrefix
public void setPrefix(String prefix)
Specifies the prefix to be added to the messages displayed by this console; may benull
.
-
getPrefix
public String getPrefix()
Returns the prefix to be added to the messages displayed by this console; may returnnull
.
-
setShowingMessageType
public void setShowingMessageType(boolean show)
Specifies whether the type of the message should be used to prefix the messages displayed by this console.
-
isShowingMessageType
public boolean isShowingMessageType()
Returnstrue
if the type of the message should be used to prefix the messages displayed by this console;false
otherwise.
-
setErrorLevel
public void setErrorLevel(Console.MessageType level)
Specifies the least severe message type displayed by this console.
-
getErrorLevel
public Console.MessageType getErrorLevel()
Returns the least severe message type displayed by this console.
-
showMessage
public void showMessage(String message, Console.MessageType messageType)
Description copied from interface:Console
Show specified message to user.- Specified by:
showMessage
in interfaceConsole
- Parameters:
message
- a possibly multi-line messagemessageType
- type of message:Console.MessageType.INFO
,Console.MessageType.WARNING
,Console.MessageType.ERROR
orConsole.MessageType.DEBUG
.
-
-