de.smartics.analysis.javadoc
Class Console

Package class diagram package Console
java.lang.Object
  extended by de.smartics.analysis.javadoc.Console
All Implemented Interfaces:
Serializable

public final class Console
     
     
extends Object
implements Serializable

Encapsulates the information returned to the console.

It is assumed that the console is closed before it is serialized. If not the instance will close itself.

Author:
Robert Reiner
See Also:
Serialized Form

Constructor Summary
Console()
          Default constructor.
 
Method Summary
 void close()
          Closes the streams and stores their content as message strings.
 String createConsoleMessage(String toolId)
          Creates a message to be printed to a console or log file.
 String getErrMessages()
          Returns the messages written to the error stream.
 String getOutMessages()
          Returns the messages written to the output stream.
 int getReturnCode()
          Returns the return code returned by the executed program.
 void setReturnCode(int returnCode)
          Sets the return code returned by the executed program.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Console

public Console()
Default constructor.

Method Detail

getReturnCode

public int getReturnCode()
Returns the return code returned by the executed program.

Returns:
the return code returned by the executed program.

setReturnCode

public void setReturnCode(int returnCode)
Sets the return code returned by the executed program.

Parameters:
returnCode - the return code returned by the executed program.

getErrMessages

public String getErrMessages()
Returns the messages written to the error stream.

Returns:
the messages written to the error stream.

getOutMessages

public String getOutMessages()
Returns the messages written to the output stream.

Returns:
the messages written to the output stream.

close

public void close()
Closes the streams and stores their content as message strings.


createConsoleMessage

public String createConsoleMessage(String toolId)
Creates a message to be printed to a console or log file.

Parameters:
toolId - the tool that issues the message.
Returns:
a message to be printed to a console or log file.


Copyright © 2008-2011 Kronseder & Reiner GmbH - smartics. All Rights Reserved.