org.extex.dviware.type
Class DviPreamble

java.lang.Object
  extended by org.extex.dviware.type.AbstractDviCode
      extended by org.extex.dviware.type.DviPreamble
All Implemented Interfaces:
DviCode

public class DviPreamble
extends AbstractDviCode

This class represents the DVI instruction pre.

Version:
$Revision: 5428 $
Author:
Gerd Neugebauer

Field Summary
 
Fields inherited from class org.extex.dviware.type.AbstractDviCode
ONE_BYTE_MASK, THREE_BYTE_MASK, TWO_BYTE_MASK
 
Fields inherited from interface org.extex.dviware.type.DviCode
POP, PUSH, W0, X0, Y0, Z0
 
Constructor Summary
DviPreamble(int mag, java.lang.String comment)
          Creates a new object.
 
Method Summary
 int write(java.io.OutputStream stream)
          Write the code to the output stream.
 
Methods inherited from class org.extex.dviware.type.AbstractDviCode
getName, opcode, opcodeSigned, variant, write2, write3, write4
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DviPreamble

public DviPreamble(int mag,
                   java.lang.String comment)
Creates a new object.

Parameters:
mag - the magnification
comment - the comment
Method Detail

write

public int write(java.io.OutputStream stream)
          throws java.io.IOException
Write the code to the output stream.

Parameters:
stream - the target stream
Returns:
the number of bytes actually written
Throws:
java.io.IOException - in case of an error
See Also:
DviCode.write(java.io.OutputStream)