JavaDoq 1.0 API

com.javadoq.html
Class Doq

java.lang.Object
  extended by com.javadoq.html.Doq
Direct Known Subclasses:
DoqCopy, DoqHTMLFile, DoqStyleSheet

public abstract class Doq
extends java.lang.Object

An abstract base class for Java source code transformers.

Author:
J.J.Liu (Jianjun Liu) at http://www.javadoq.com

Field Summary
protected  java.lang.String fileName
          Absolute path of the source file to transform.
protected  java.io.FileWriter fileWriter
          A FileWriter to the target file.
protected static java.lang.String LINE_SEPARATOR
          A line-separator.
protected static java.lang.String STYLE_SHEET
          Cascade style sheet.
 
Constructor Summary
protected Doq(java.lang.String fileName)
          Constructs a Doq transformer, creates and opens the target file.
 
Method Summary
 void close()
          Closes the target file.
 void write(char c)
          Writes a char to the target file.
 void write(java.lang.String str)
          Writes a string to the target file.
 void writeLine(java.lang.String str)
          Writes a line to the target file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LINE_SEPARATOR

protected static final java.lang.String LINE_SEPARATOR

A line-separator.

Since:
1.0

STYLE_SHEET

protected static final java.lang.String STYLE_SHEET

Cascade style sheet.

Since:
1.0
See Also:
Constant Field Values

fileName

protected final java.lang.String fileName

Absolute path of the source file to transform.

Since:
1.0

fileWriter

protected final java.io.FileWriter fileWriter

A FileWriter to the target file.

Since:
1.0
Constructor Detail

Doq

protected Doq(java.lang.String fileName)

Constructs a Doq transformer, creates and opens the target file.

Parameters:
fileName - The absolute path of the source file to transform.
Since:
1.0
Method Detail

close

public void close()

Closes the target file.

Since:
1.0

write

public final void write(char c)

Writes a char to the target file.

Parameters:
c - A char
Since:
1.0

write

public final void write(java.lang.String str)

Writes a string to the target file.

Parameters:
str - A string
Since:
1.0

writeLine

public final void writeLine(java.lang.String str)

Writes a line to the target file.

Parameters:
str - A line of string
Since:
1.0

JavaDoq 1.0 API

Copyright © 2008-2011 J.J.Liu (www.javadoq.com). All Rights Reserved.