Class TextsProvider

java.lang.Object

net.sourceforge.jnlp.util.docprovider.TextsProvider

Direct Known Subclasses:

IcedTeaWebTextsProvider, ItwebPluginTextProvider, ItwebSettingsTextsProvider, JavaWsTextsProvider, PolicyEditorTextsProvider

public abstract class TextsProvider
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private String	authorLineImpl
private static String	authorsLine
private static final int	BUF_SIZE
static final String	DISTRO_PKG
private final Charset	encoding
protected final boolean	expandVariables
private final boolean	forceTitles
private final Formatter	formatter
private static final String	IT_BASE
static final String	IT_MAIN
private static final String	IT_NEW_HOME
static final String	IT_QUICK
static final String	ITW
static final String	ITW_BUGS
static final String	ITW_BUGZILLAHOME
static final String	ITW_EAS
static final String	ITW_ECLIPSE
static final String	ITW_HOME
static final String	ITW_ISSUES
static final String	ITW_PLUGIN
static final String	ITW_PLUGIN_URL
private static final String	ITW_REPO
static final String	ITW_REPRODUCERS
static final String	ITW_STYLE
private static final String	logo_name
private static final String	logo_url
private boolean	prepared
private boolean	seeAlso

Constructor Summary

Constructors

Constructor	Description
TextsProvider(Charset encoding, Formatter formatter, boolean forceTitles, boolean expandFiles)

Method Summary

Modifier and Type	Method	Description
private static long	copy(InputStream from, OutputStream to)
private static void	generateAll(File f, boolean expand)
private String	generateAuthorsSection(String authors)
private static void	generateHtmlTexts(File dir, boolean includeXmlHeader, boolean expand)
private static void	generateHtmlTexts(File dir, boolean allowContext, boolean allowLogo, boolean includeXmlHeader, boolean titles, boolean expand)
private static void	generateHtmlTextsUtf8(File dir, boolean includeXmlHeader, boolean expand)
private static void	generateItwIntro(File f, boolean expand)
private static void	generateManText(Charset encoding, File dir, boolean expand)
private static void	generateManText(Charset encoding, File dir, boolean titles, boolean expand)
private static void	generateOnlineHtmlHelp(File f, boolean expand)
private static void	generatePlainTextDocs(File dir, int lineWidth, boolean expand)
private static void	generatePlainTextDocs(Charset encoding, File dir, int lineWidth, boolean expand)
static void	generateRuntimeHtmlTexts(File f)
private String	getAuthors()
private String	getBugs()
String	getCommands()
String	getDescription()
private Charset	getEncoding()
String	getExamples()
String	getFiles()
protected String	getFiles(List<InfrastructureFileDescriptor> files)
protected String	getFilesAppendix()
Formatter	getFormatter()
private String	getHeader()
abstract String	getId()
String	getIntroduction()
String	getOptions()
private String	getSeeAlso()
String	getSynopsis()
private String	getTail()
private boolean	isSeeAlso()
static void	main(String[] args)
protected boolean	matchStringsValueWithInfrastructureFile(Setting entry, InfrastructureFileDescriptor f)
protected String	optionsToString(List<CommandLineOptions> opts)
TextsProvider	prepare()
(package private) String	readAuthors(String authors)
(package private) String	readAuthorsImpl(String authors)
private String	removeFileProtocol(String s)
private void	setAuthorFilePath(String authorFilePath)
void	setSeeAlso(boolean seeAlso)
private void	writeToDir(File dir)
void	writeToFile(File f)
private void	writeToStream(OutputStream os)
String	writeToString()
private String	writeToStringReal()
private void	writeToWriter(Writer w)

Methods inherited from class Object

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

Field Details

authorsLine

private static String authorsLine

encoding

private final Charset encoding

formatter

private final Formatter formatter

forceTitles

private final boolean forceTitles

expandVariables

protected final boolean expandVariables

prepared

private boolean prepared

authorLineImpl

private String authorLineImpl

seeAlso

private boolean seeAlso

IT_NEW_HOME

private static final String IT_NEW_HOME

See Also:

• Constant Field Values

IT_BASE

private static final String IT_BASE

See Also:

• Constant Field Values

ITW_HOME

public static final String ITW_HOME

See Also:

• Constant Field Values

ITW_EAS

public static final String ITW_EAS

See Also:

• Constant Field Values

ITW_STYLE

public static final String ITW_STYLE

See Also:

• Constant Field Values

ITW_ECLIPSE

public static final String ITW_ECLIPSE

See Also:

• Constant Field Values

ITW_REPO

private static final String ITW_REPO

See Also:

• Constant Field Values

ITW

public static final String ITW

See Also:

• Constant Field Values

ITW_PLUGIN

public static final String ITW_PLUGIN

See Also:

• Constant Field Values

DISTRO_PKG

public static final String DISTRO_PKG

See Also:

• Constant Field Values

IT_MAIN

public static final String IT_MAIN

See Also:

• Constant Field Values

IT_QUICK

public static final String IT_QUICK

See Also:

• Constant Field Values

ITW_ISSUES

public static final String ITW_ISSUES

See Also:

• Constant Field Values

ITW_REPRODUCERS

public static final String ITW_REPRODUCERS

See Also:

• Constant Field Values

ITW_BUGS

public static final String ITW_BUGS

See Also:

• Constant Field Values

ITW_PLUGIN_URL

public static final String ITW_PLUGIN_URL

See Also:

• Constant Field Values

ITW_BUGZILLAHOME

public static final String ITW_BUGZILLAHOME

See Also:

• Constant Field Values

logo_name

private static final String logo_name

See Also:

• Constant Field Values

logo_url

private static final String logo_url

See Also:

• Constant Field Values

BUF_SIZE

private static final int BUF_SIZE

See Also:

• Constant Field Values

Constructor Details

TextsProvider

public TextsProvider(Charset encoding,
 Formatter formatter,
 boolean forceTitles,
 boolean expandFiles)

Method Details

getId

public abstract String getId()

getHeader

private String getHeader()

getTail

private String getTail()

getIntroduction

public String getIntroduction()

getSynopsis

public String getSynopsis()

getDescription

public String getDescription()

getOptions

public String getOptions()

getCommands

public String getCommands()

getExamples

public String getExamples()

getFiles

public String getFiles()

getFilesAppendix

protected String getFilesAppendix()

getFiles

protected String getFiles(List<InfrastructureFileDescriptor> files)

matchStringsValueWithInfrastructureFile

protected boolean matchStringsValueWithInfrastructureFile(Setting entry,
 InfrastructureFileDescriptor f)

getFormatter

public Formatter getFormatter()

getEncoding

private Charset getEncoding()

optionsToString

protected String optionsToString(List<CommandLineOptions> opts)

getBugs

private String getBugs()

getAuthors

private String getAuthors()

getSeeAlso

private String getSeeAlso()

prepare

public TextsProvider prepare()

writeToString

public String writeToString()

writeToStringReal

private String writeToStringReal()

writeToWriter

private void writeToWriter(Writer w)
                    throws IOException

Throws:

IOException

writeToStream

private void writeToStream(OutputStream os)
                    throws IOException

Throws:

IOException

writeToFile

public void writeToFile(File f)
                 throws IOException

Throws:

IOException

writeToDir

private void writeToDir(File dir)
                 throws IOException

Throws:

IOException

main

public static void main(String[] args)
                 throws IOException

Throws:

IOException

generateItwIntro

private static void generateItwIntro(File f,
 boolean expand)
                              throws IOException

Throws:

IOException

generateAll

private static void generateAll(File f,
 boolean expand)
                         throws IOException

Throws:

IOException

generateRuntimeHtmlTexts

public static void generateRuntimeHtmlTexts(File f)
                                     throws IOException

Throws:

IOException

generateOnlineHtmlHelp

private static void generateOnlineHtmlHelp(File f,
 boolean expand)
                                    throws IOException

Throws:

IOException

generateHtmlTexts

private static void generateHtmlTexts(File dir,
 boolean includeXmlHeader,
 boolean expand)
                               throws IOException

Throws:

IOException

generateHtmlTextsUtf8

private static void generateHtmlTextsUtf8(File dir,
 boolean includeXmlHeader,
 boolean expand)
                                   throws IOException

Throws:

IOException

generateHtmlTexts

private static void generateHtmlTexts(File dir,
 boolean allowContext,
 boolean allowLogo,
 boolean includeXmlHeader,
 boolean titles,
 boolean expand)
                               throws IOException

Throws:

IOException

generateManText

private static void generateManText(Charset encoding,
 File dir,
 boolean expand)
                             throws IOException

Throws:

IOException

generateManText

private static void generateManText(Charset encoding,
 File dir,
 boolean titles,
 boolean expand)
                             throws IOException

Throws:

IOException

generatePlainTextDocs

private static void generatePlainTextDocs(File dir,
 int lineWidth,
 boolean expand)
                                   throws IOException

Throws:

IOException

generatePlainTextDocs

private static void generatePlainTextDocs(Charset encoding,
 File dir,
 int lineWidth,
 boolean expand)
                                   throws IOException

Throws:

IOException

copy

private static long copy(InputStream from,
 OutputStream to)
                  throws IOException

Throws:

IOException

setAuthorFilePath

private void setAuthorFilePath(String authorFilePath)

isSeeAlso

private boolean isSeeAlso()

Returns:

the seeAlso

setSeeAlso

public void setSeeAlso(boolean seeAlso)

Parameters:

seeAlso - the seeAlso to set

removeFileProtocol

private String removeFileProtocol(String s)

readAuthors

String readAuthors(String authors)

readAuthorsImpl

String readAuthorsImpl(String authors)
                throws IOException

Throws:

IOException

generateAuthorsSection

private String generateAuthorsSection(String authors)