org.docgene.help.utils

Class HelpUtilities

java.lang.Object

org.docgene.help.utils.HelpUtilities

public class HelpUtilities
extends java.lang.Object

A utilities class for the Help system.

Constructor Summary

Constructors

Constructor and Description
HelpUtilities()

Method Summary

Modifier and Type	Method and Description
static java.net.URL	getChildURL(java.net.URL parentURL, java.lang.String path) Return an URL by its relative path from a parent URL.
static java.net.URL	getEntryURL(java.net.URL parentURL, java.lang.String path) Return an URL by its relative path from a parent URL.
static java.lang.String	getFileExtension(java.net.URL url) Return the extension of a URL.
static java.lang.String	getFileNameWithExtension(java.net.URL url) Return the URL name without the path, nor the extension.
static java.net.URL	getParentURL(java.net.URL url) Return the parent URL of a given URL.
static java.lang.String	getRelativePath(java.net.URL originURL, java.net.URL url) Return the path of an URL relative to a directory.
static java.net.URL	getStyleSheet(java.net.URL url)
static boolean	isAtLeastVersion(java.lang.String javaVersion) Return true if the current Java version is at least equal to the specified version.
static boolean	isHTML(java.net.URL url)
static boolean	isHTTP(java.net.URL url) Return true if an URL use the http protocol.
static boolean	isHTTPProtocol(java.net.URL url) Return true if the protocol is a http, or https protocol.
static boolean	isJarProtocol(java.net.URL url) Return true if the protocol is a jar protocol.
static boolean	isRelative(java.net.URL baseURL, java.net.URL url) Return the path of an URL relative to a directory.
static java.net.URL	normalize(java.net.URL url) Normalize an URL by removing "." and ".." in the path part of the URL.
static java.lang.String	normalizeString(java.lang.String st) Replaces white space characters by underscores.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpUtilities

public HelpUtilities()

Method Detail

normalizeString

public static java.lang.String normalizeString(java.lang.String st)

Replaces white space characters by underscores. Also more than one spaces have been replaces by one space.

Parameters:

st - the String

Returns:

the normalized String

getFileNameWithExtension

public static java.lang.String getFileNameWithExtension(java.net.URL url)

Return the URL name without the path, nor the extension. For example the URL "file:///C:/myDir/myFile.xml" will return myFile.xml.

Parameters:

url - the URL

Returns:

the URL name without the extension

getEntryURL

public static java.net.URL getEntryURL(java.net.URL parentURL,
                                       java.lang.String path)
                                throws java.net.MalformedURLException

Return an URL by its relative path from a parent URL.

Parameters:

parentURL - the parent URL

path - the path of the child relative to the parent

Returns:

the child URL

Throws:

java.net.MalformedURLException

getStyleSheet

public static java.net.URL getStyleSheet(java.net.URL url)

getParentURL

public static java.net.URL getParentURL(java.net.URL url)

Return the parent URL of a given URL.

Parameters:

url - the URL

Returns:

the parent URL

getChildURL

public static java.net.URL getChildURL(java.net.URL parentURL,
                                       java.lang.String path)

Return an URL by its relative path from a parent URL.

Parameters:

parentURL - the parent URL

path - the path of the child relative to the parent

Returns:

the child URL

getRelativePath

public static java.lang.String getRelativePath(java.net.URL originURL,
                                               java.net.URL url)

Return the path of an URL relative to a directory.

Parameters:

originURL - the origin URL

url - the URL

Returns:

the path of the URL relative to the directory

normalize

public static java.net.URL normalize(java.net.URL url)

Normalize an URL by removing "." and ".." in the path part of the URL.

Parameters:

url - the URL

Returns:

the normalized URL

isHTTPProtocol

public static boolean isHTTPProtocol(java.net.URL url)

Return true if the protocol is a http, or https protocol.

Parameters:

url - the URL

Returns:

true if the protocol is a http, or https protocol.

isJarProtocol

public static boolean isJarProtocol(java.net.URL url)

Return true if the protocol is a jar protocol.

Parameters:

url - the URL

Returns:

true if the protocol is a jar, or zip protocol.

isRelative

public static boolean isRelative(java.net.URL baseURL,
                                 java.net.URL url)

Return the path of an URL relative to a directory.

Parameters:

baseURL - the base directory

url - the URL

Returns:

the path of the URL relative to the directory

getFileExtension

public static java.lang.String getFileExtension(java.net.URL url)

Return the extension of a URL.

Parameters:

url - the URL

Returns:

the File extension of the URL, or null if the URL does not have an extension

isHTTP

public static boolean isHTTP(java.net.URL url)

Return true if an URL use the http protocol.

Parameters:

url - the URL

Returns:

true if the URL use the http protocol

isHTML

public static boolean isHTML(java.net.URL url)

isAtLeastVersion

public static final boolean isAtLeastVersion(java.lang.String javaVersion)

Return true if the current Java version is at least equal to the specified version. The algorithm take care of the pattern for the String-naming convention for the version, taking into account all digits, including those used for the maintenance version but not using the last part used for non-GA versions (see J2SE SDK/JRE Version String Naming Convention).

For example, if the current version is 1.7.0_13, the result would be, depending on the specified Java version:

• 1.7: as 1.7.0_13 ≥ 1.7, the method would return true
• 1.7.0_14: as 1.7.0_13 < 1.7.0_14, the method would return false
• 1.7.0_12: as 1.7.0_13 ≥ 1.7.0_12, the method would return true

Parameters:

javaVersion - the specified Java version

Returns:

true if the current Java version is at least equal to the specified version