Method Detail

• encodeFragment

  public static String encodeFragment(String text)

  Deprecated. This method was used for the original apt format, which removed all non alphanumeric characters from anchors. Use encodeAnchor(String) instead.
  Replace all characters in a text.

   AptTools.encodeFragment( null ) = null
   AptTools.encodeFragment( "" ) = ""
   AptTools.encodeFragment( "http://www.google.com" ) = "httpwwwgooglecom"
   

  Parameters:

  text - the String to check, may be null.

  Returns:

  the text with only letter and digit, null if null String input.

• isExternalLink

  public static boolean isExternalLink(String link)

  Checks if the given string corresponds to an external URI, ie is not a link within the same document nor a link to another document within the same site. This forwards to DoxiaUtils.isExternalLink(String).

  Parameters:

  link - The link to check.

  Returns:

  True if DoxiaUtils.isExternalLink(link) returns true.

  See Also:

  DoxiaUtils.isExternalLink(String), isInternalLink(String), isLocalLink(String)

• isInternalLink

  public static boolean isInternalLink(String link)

  Checks if the given string corresponds to an internal link, ie it is a link to an anchor within the same document.

  Parameters:

  link - The link to check.

  Returns:

  True if link is neither an external nor a local link.

  See Also:

  DoxiaUtils.isInternalLink(String), isExternalLink(String), isLocalLink(String)

• isLocalLink

  public static boolean isLocalLink(String link)

  Checks if the given string corresponds to a relative link to another document within the same site.

  Parameters:

  link - The link to check.

  Returns:

  True if the link starts with either "/", "./" or "../".

  See Also:

  DoxiaUtils.isLocalLink(String), isExternalLink(String), isInternalLink(String)

• linkToKey

  public static String linkToKey(String text)

  Deprecated. This method was used for the original apt format, which removed all non alphanumeric characters from anchors. Use encodeAnchor(String) instead.
  Transforms the given text such that it can be used as a link. All non-LetterOrDigit characters are removed and the remaining characters are transformed to lower-case.

  Parameters:

  text - The text to transform.

  Returns:

  The text with all non-LetterOrDigit characters removed.

• encodeAnchor

  public static String encodeAnchor(String id)

  Construct a valid anchor. This is a simplified version of DoxiaUtils.encodeId(String) to ensure the anchor is a valid Doxia id. The procedure is identical to the one in HtmlTools.encodeId(String):

  1. Trim the id
  2. If the first character is not a letter, prepend the letter 'a'
  3. Any space is replaced with an underscore '_'
  4. Remove any non alphanumeric characters except ':', '_', '.', '-'.

  Parameters:

  id - The id to be encoded.

  Returns:

  The trimmed and encoded id, or null if id is null.