Class LinkUtilities

java.lang.Object

com.ibm.icu.util.LinkUtilities

public class LinkUtilities
extends Object

Utility class for assisting with detecting links (URLs or emails) in text, and formatting them for display, implementing the algorithms in https://www.unicode.org/reports/tr58/ to handle Unicode characters properly. It supplies lower level APIs for use in augmenting existing scanners and formatters.

Status:

Draft ICU 79.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LinkUtilities.Extent	Enum for determining whether any percent-escaping is minimal or maximal, for use with invalid reference #escapePathQueryFragment() .

Method Summary

Modifier and Type	Method	Description
static String	escapePathQueryFragment(String source, LinkUtilities.Extent extent)	Escapes a URL according to the Extent parameter
static int	scanBackEmailLocalPart(CharSequence source, int start, int limit)	Lower level utility for finding the start of an email address in text.
static int	scanPathQueryFragment(CharSequence source, int start, int limit)	Lower level utility for finding the end of a PathQueryFragment (PQF) in text.

Methods inherited from class Object

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

Method Details

scanPathQueryFragment

public static int scanPathQueryFragment(CharSequence source,
 int start,
 int limit)

Lower level utility for finding the end of a PathQueryFragment (PQF) in text. It assumes that the start position is immediately after an identified domain name. The purpose of this routine is for fitting into algorithms that are already in use, just taking over for the PQF scanning. For more information, see https://www.unicode.org/reports/tr58/.

Parameters:

source - the text to be scanned

start - the position in the text to be scanned from. It should be immediately after a domain name.

Returns:

the exclusive-end position of the PQF, or the start value if there is none.

Status:

Draft ICU 79.

scanBackEmailLocalPart

public static int scanBackEmailLocalPart(CharSequence source,
 int start,
 int limit)

Lower level utility for finding the start of an email address in text. It assumes that the limit position is at an '@' + identified domain name, and will scan backwards from there. The purpose of this routine is for fitting into algorithms that are already in use, just handling the email local-part. It does not scan back through "mailto:".

Parameters:

source - the text to be scanned

start - the position that is the earliest that should be considered in a backwards scan

limit - the position to start scanning backwards from — should be the position of the '@' (which is just before the domain_name)

Returns:

the start of the email local part, or limit if no email local part is found

Status:

Draft ICU 79.

escapePathQueryFragment

public static String escapePathQueryFragment(String source,
 LinkUtilities.Extent extent)

Escapes a URL according to the Extent parameter

Parameters:

source - In the source, it is assumed that ASCII syntax characters requiring escaping have already been escaped. For example, a literal / in a path segment would already be percent-escaped. For more information, see https://www.unicode.org/reports/tr58/.

extent - either MINIMAL or MAXIMAL

Returns:

an escaped string according to the extent parameter.

Status:

Draft ICU 79.