Lassi

Overview

Package

Class

Tree

Index

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

be.lassi.web
Class JavadocBuilder

java.lang.Object
  be.lassi.web.PageBuilder
      be.lassi.web.DocBuilder
          be.lassi.web.JavadocBuilder

public class JavadocBuilder
extends DocBuilder
extends DocBuilder

Adds the LASSI navigation at the top of the Javadoc html pages.

Constructor Summary
`JavadocBuilder(java.lang.String sourceDir, java.lang.String targetDir)` Constructs a new instance.

Method Summary
`static void`	`main(java.lang.String[] args)` Processes the javadoc files.
`protected java.lang.String`	`path(int depth)` Gets the path to the root directory from a directory at given depth.
`protected void`	`processLine(Page page, java.lang.String string)` Processes html file line, insert LASSI navigation bar when correct location found.

Methods inherited from class be.lassi.web.DocBuilder
`exclude, process`

Methods inherited from class be.lassi.web.PageBuilder
`depth, getSourceDir, sourceFilename`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

JavadocBuilder

public JavadocBuilder(java.lang.String sourceDir,
                      java.lang.String targetDir)

Constructs a new instance.

Parameters:: sourceDir - the directory with the html pages to be changed; targetDir - the directory with the html pages after change

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Processes the javadoc files.

Parameters:: args - the command line arguments
Throws:: java.io.IOException - if problem with reading or writing the files

path

protected java.lang.String path(int depth)

Description copied from class: PageBuilder

Gets the path to the root directory from a directory at given depth.

Overrides:: path in class PageBuilder

Parameters:: depth - the sub-directory depth
Returns:: the path to the root

processLine

protected void processLine(Page page,
                           java.lang.String string)

Processes html file line, insert LASSI navigation bar when correct location found.

Overrides:: processLine in class DocBuilder

string - the line to be processed