pmp
Class InputOutput

java.lang.Object
  extended by pmp.Macroprocessor.Component
      extended by pmp.InputOutput
Direct Known Subclasses:
FileIO, StringIO

public class InputOutput
extends Macroprocessor.Component

Interface for Macroprocessor input/output system.

Title: PMP: Macroprocessor

Description: Java macroprocessor

Copyright: Copyright (c) 2005

Version:
1.0
Author:
Luděk Hlaváček

Field Summary
static java.lang.String ERR_OUTPUT
          Use stderr as output.
static java.lang.String NULL_INPUT
          Use empty input.
static java.lang.String NULL_OUTPUT
          Discard output.
static java.lang.String RANDOM_INPUT
          Use random generator as input.
static java.lang.String STD_INPUT
          Use stdin as input.
static java.lang.String STD_OUTPUT
          Use stdout as output.
 
Constructor Summary
InputOutput(Macroprocessor mp)
           
 
Method Summary
 void debugHandler(java.lang.String debugmessage)
           
 void errorHandler(java.lang.String error)
          This method should produce some kind of error message and then raise FatalParserException.
 InputSource getDefaultInput()
          Returns default input source.
 InputSource getInput(java.lang.String name)
          Return new Input object for given source.
 void noticeHandler(java.lang.String noticemessage)
           
 void setOutput(java.lang.String name)
          Redirects output of macroprocessor to specified location.
 void warningHandler(java.lang.String warning)
           
 void write(java.lang.String str)
          Provides direct connection to output Writer Must be reimplemented by subclasses.
 
Methods inherited from class pmp.Macroprocessor.Component
error, getMP, getMPAnalyzer, getMPIO, getMPIQ, getMPMacros, notice, warning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STD_INPUT

public static final java.lang.String STD_INPUT
Use stdin as input.

See Also:
Constant Field Values

STD_OUTPUT

public static final java.lang.String STD_OUTPUT
Use stdout as output.

See Also:
Constant Field Values

ERR_OUTPUT

public static final java.lang.String ERR_OUTPUT
Use stderr as output.

See Also:
Constant Field Values

NULL_OUTPUT

public static final java.lang.String NULL_OUTPUT
Discard output.

See Also:
Constant Field Values

RANDOM_INPUT

public static final java.lang.String RANDOM_INPUT
Use random generator as input.

See Also:
Constant Field Values
To Do:
not yet implemented

NULL_INPUT

public static final java.lang.String NULL_INPUT
Use empty input.

See Also:
Constant Field Values
Constructor Detail

InputOutput

public InputOutput(Macroprocessor mp)
Method Detail

getDefaultInput

public InputSource getDefaultInput()
Returns default input source. May return null. In that case user must fill InputQueue of macroprocessor manually.

Returns:
default input source.

getInput

public InputSource getInput(java.lang.String name)
Return new Input object for given source. Must be reimplemented by subclasses.

Parameters:
name - name of source
Returns:
returns InputSource object for given source

setOutput

public void setOutput(java.lang.String name)
Redirects output of macroprocessor to specified location. Must be reimplemented by subclasses.

Parameters:
name - name of output

write

public void write(java.lang.String str)
Provides direct connection to output Writer Must be reimplemented by subclasses.

Parameters:
str - string to be written to output

errorHandler

public void errorHandler(java.lang.String error)
                  throws FatalParserException
This method should produce some kind of error message and then raise FatalParserException.

Parameters:
error - error message
Throws:
FatalParserException - this exception should be thrown by all subclasses

warningHandler

public void warningHandler(java.lang.String warning)

noticeHandler

public void noticeHandler(java.lang.String noticemessage)

debugHandler

public void debugHandler(java.lang.String debugmessage)