public final class HTML
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.text.SimpleDateFormat |
OUTPUT_DATE_FORMAT |
static java.text.SimpleDateFormat |
OUTPUT_DATE_TIME_FORMAT |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
escape(java.lang.String text)
Escapes HTML meta characters "&", "<", ">" and turns "\n" line breaks
into HTML line breaks ("
"); |
static java.lang.String |
escapeAuthorName(java.lang.String authorName)
Escapes evil characters in author's names.
|
static java.lang.String |
escapeDirectoryName(java.lang.String directoryName) |
static java.lang.String |
escapeUrl(java.lang.String text)
Escapes HTML as well as " as it is not valid in URL.
|
static java.lang.String |
escapeUrlParameters(java.lang.String text)
Escapes HTML as well as " as it is not valid in URL.
|
static java.lang.String |
getAffectedFilesCount(java.util.Set files)
Returns HTML code for number of affected files
|
static java.lang.String |
getAuthorIdLink(Author author)
Returns HTML code for a link to an author Id page
|
static java.lang.String |
getAuthorLink(Author author)
Returns HTML code for a link to an author page
|
static java.lang.String |
getDate(java.util.Date date)
Returns HTML code for a date
|
static java.lang.String |
getDateAndTime(java.util.Date date)
Returns HTML code for a date, including time
|
static java.lang.String |
getDirectoryLink(Directory directory)
Returns HTML code for a directory page link
|
static java.lang.String |
getIcon(java.lang.String iconFilename)
Generates HTML for an icon
|
static java.lang.String |
getIcon(java.lang.String iconFilename,
java.lang.String title)
Generates HTML for an icon
|
static java.lang.String |
getLink(java.lang.String link,
java.lang.String linkName)
Creates a HTML representation of a hyperlink
|
static java.lang.String |
getLink(java.lang.String link,
java.lang.String linkName,
java.lang.String prefix,
java.lang.String suffix)
Creates a HTML representation of a hyperlink
|
static java.lang.String |
getRevisionNumber(java.lang.String revisionNumber)
Returns HTML code for a revision number
|
static java.lang.String |
webifyLinksFromPlainText(java.lang.String plainText)
From a plain text comment identify the http: and https links and create a link for them.
|
public static final java.text.SimpleDateFormat OUTPUT_DATE_FORMAT
public static final java.text.SimpleDateFormat OUTPUT_DATE_TIME_FORMAT
public static java.lang.String getLink(java.lang.String link, java.lang.String linkName)
link
- URLlinkName
- Name of the Linkpublic static java.lang.String getLink(java.lang.String link, java.lang.String linkName, java.lang.String prefix, java.lang.String suffix)
link
- URLlinkName
- Name of the Linkprefix
- A prefix to be inserted before the link label; no HTML escaping is performedprefix
- A suffix to be inserted after the link label; no HTML escaping is performedpublic static java.lang.String getAuthorLink(Author author)
author
- the authorpublic static java.lang.String getAuthorIdLink(Author author)
author
- the authorpublic static java.lang.String getDate(java.util.Date date)
date
- the datepublic static java.lang.String getAffectedFilesCount(java.util.Set files)
files
- affected filespublic static java.lang.String getDateAndTime(java.util.Date date)
date
- the datepublic static java.lang.String getRevisionNumber(java.lang.String revisionNumber)
revisionNumber
- a revision numberpublic static java.lang.String getDirectoryLink(Directory directory)
directory
- a directorypublic static java.lang.String getIcon(java.lang.String iconFilename)
iconFilename
- an icon filename (HTMLOutput.XXXX_ICON constants)public static java.lang.String getIcon(java.lang.String iconFilename, java.lang.String title)
iconFilename
- an icon filename (HTMLOutput.XXXX_ICON constants)title
- the title for the icon.public static java.lang.String escapeAuthorName(java.lang.String authorName)
Escapes evil characters in author's names. E.g. "#" must be escaped because for an author "my#name" a page "author_my#name.html" will be created, and you can't link to that in HTML
TODO: Replace everything *but* known good characters, instead of just evil onesauthorName
- an author's namepublic static java.lang.String escapeDirectoryName(java.lang.String directoryName)
public static java.lang.String escape(java.lang.String text)
text
- some string, for example "x > 0 && y < 100"public static java.lang.String escapeUrl(java.lang.String text)
text
- some string, for example "x > 0 && y < 100"public static java.lang.String escapeUrlParameters(java.lang.String text)
text
- some string, for example "x > 0 && y < 100"public static java.lang.String webifyLinksFromPlainText(java.lang.String plainText)
plainText
-