org.jboss.aesh.extensions.manual.parser

Class ManPageLoader

java.lang.Object

org.jboss.aesh.extensions.manual.parser.ManPageLoader

All Implemented Interfaces:

PageLoader

public class ManPageLoader
extends Object
implements PageLoader

Read a asciidoc file and parse it to something that can be displayed nicely in a terminal.

Author:

Ståle W. Pedersen

Constructor Summary

Constructors

Constructor and Description
ManPageLoader()

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAsList()
String	getName()
String	getResourceName()
List<ManSection>	getSections()
List<String>	loadPage(int columns)
String	print()
void	setFile(File file) Read from a specified file.
void	setFile(InputStream input, String fileName)
void	setFile(String filename) Read from a specified filename.
void	setFileFromAJar(String fileName) Read a file resouce located in a jar
void	setUrlFile(URL url)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManPageLoader

public ManPageLoader()

Method Detail

setFile

public void setFile(String filename)
             throws IOException

Read from a specified filename. Also supports gzipped files.

Parameters:

filename - File

Throws:

IOException

setFile

public void setFile(File file)
             throws IOException

Read from a specified file. Also supports gzipped files.

Parameters:

file - File

Throws:

IOException

setUrlFile

public void setUrlFile(URL url)
                throws IOException

Throws:

IOException

setFile

public void setFile(InputStream input,
           String fileName)
             throws IOException

Throws:

IOException

setFileFromAJar

public void setFileFromAJar(String fileName)

Read a file resouce located in a jar

Parameters:

fileName - name

getResourceName

public String getResourceName()

Specified by:

getResourceName in interface PageLoader

getName

public String getName()

loadPage

public List<String> loadPage(int columns)
                      throws IOException

Specified by:

loadPage in interface PageLoader

Throws:

IOException

getSections

public List<ManSection> getSections()

getAsList

public List<String> getAsList()

print

public String print()