Package com.intellij.util.io

Class URLUtil

java.lang.Object

com.intellij.util.io.URLUtil

public final class URLUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	DATA_URI_PATTERN
static java.lang.String	FILE_PROTOCOL
static java.util.regex.Pattern	FILE_URL_PATTERN
static java.util.regex.Pattern	HREF_PATTERN
static java.lang.String	HTTP_PROTOCOL
static java.lang.String	JAR_PROTOCOL
static java.lang.String	JAR_SEPARATOR
static java.lang.String	JRT_PROTOCOL
static java.lang.String	SCHEME_SEPARATOR
static java.util.regex.Pattern	URL_PATTERN
static java.util.regex.Pattern	URL_WITH_PARENS_PATTERN

Method Summary

Modifier and Type	Method and Description
static boolean	canContainUrl(java.lang.String line)
static boolean	containsScheme(java.lang.String url)
static java.lang.String	decode(java.lang.String string)
static java.lang.String	encodeURIComponent(java.lang.String s) Encodes a URI component by replacing each instance of certain characters by one, two, three, or four escape sequences representing the UTF-8 encoding of the character.
static TextRange	findUrl(java.lang.CharSequence text, int startOffset, int endOffset) Finds the first range in text containing URL.
static byte []	getBytesFromDataUri(java.lang.String dataUrl) Extracts byte array from given data:URL string.
static java.net.URI	getJarEntryUri(java.net.URI file, java.lang.String pathInJar)
static java.net.URL	getJarEntryURL(java.io.File file, java.lang.String pathInJar)
static java.net.URL	getJarEntryURL(java.net.URI file, java.lang.String pathInJar)
static boolean	isDataUri(java.lang.String value)
static java.io.InputStream	openResourceStream(java.net.URL url)
static java.io.InputStream	openStream(java.net.URL url) Opens a url stream.
static java.lang.String	parseHostFromSshUrl(java.lang.String sshUrl)
static ThreeState	resourceExists(java.net.URL url) Checks whether local resource specified by url exists.
static Pair<java.lang.String,java.lang.String>	splitJarUrl(java.lang.String url) Splits .jar URL along a separator and strips "jar" and "file" prefixes if any.
static java.lang.CharSequence	unescapePercentSequences(java.lang.CharSequence s, int from, int end)
static java.lang.String	unescapePercentSequences(java.lang.String s)
static java.io.File	urlToFile(java.net.URL url)

Methods inherited from class java.lang.Object

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

Field Detail

SCHEME_SEPARATOR

public static final java.lang.String SCHEME_SEPARATOR

See Also:

Constant Field Values

FILE_PROTOCOL

public static final java.lang.String FILE_PROTOCOL

See Also:

Constant Field Values

HTTP_PROTOCOL

public static final java.lang.String HTTP_PROTOCOL

See Also:

Constant Field Values

JAR_PROTOCOL

public static final java.lang.String JAR_PROTOCOL

See Also:

Constant Field Values

JRT_PROTOCOL

public static final java.lang.String JRT_PROTOCOL

See Also:

Constant Field Values

JAR_SEPARATOR

public static final java.lang.String JAR_SEPARATOR

See Also:

Constant Field Values

DATA_URI_PATTERN

public static final java.util.regex.Pattern DATA_URI_PATTERN

URL_PATTERN

public static final java.util.regex.Pattern URL_PATTERN

URL_WITH_PARENS_PATTERN

public static final java.util.regex.Pattern URL_WITH_PARENS_PATTERN

FILE_URL_PATTERN

public static final java.util.regex.Pattern FILE_URL_PATTERN

HREF_PATTERN

public static final java.util.regex.Pattern HREF_PATTERN

Method Detail

canContainUrl

public static boolean canContainUrl(java.lang.String line)

Returns:

if false, then the line contains no URL; if true, then more heavy URL_PATTERN check should be used.

openStream

public static java.io.InputStream openStream(java.net.URL url)
                                      throws java.io.IOException

Opens a url stream. The semantics is the sames as URL.openStream(). The separate method is needed, since jar URLs open jars via JarFactory and thus keep them mapped into memory.

Throws:

java.io.IOException

openResourceStream

public static java.io.InputStream openResourceStream(java.net.URL url)
                                              throws java.io.IOException

Throws:

java.io.IOException

resourceExists

public static ThreeState resourceExists(java.net.URL url)

Checks whether local resource specified by url exists. Returns ThreeState.UNSURE if url point to a remote resource.

splitJarUrl

public static Pair<java.lang.String,java.lang.String> splitJarUrl(java.lang.String url)

Splits .jar URL along a separator and strips "jar" and "file" prefixes if any. Returns a pair of path to a .jar file and entry name inside a .jar, or null if the URL does not contain a separator.

E.g. "jar:file:///path/to/jar.jar!/resource.xml" is converted into ["/path/to/jar.jar", "resource.xml"].

Please note that the first part is platform-dependent - see UrlUtilTest.testJarUrlSplitter() for examples.

urlToFile

public static java.io.File urlToFile(java.net.URL url)

unescapePercentSequences

public static java.lang.String unescapePercentSequences(java.lang.String s)

unescapePercentSequences

public static java.lang.CharSequence unescapePercentSequences(java.lang.CharSequence s,
                                                              int from,
                                                              int end)

containsScheme

public static boolean containsScheme(java.lang.String url)

isDataUri

public static boolean isDataUri(java.lang.String value)

getBytesFromDataUri

public static byte [] getBytesFromDataUri(java.lang.String dataUrl)

Extracts byte array from given data:URL string. data:URL will be decoded from base64 if it contains the marker of base64 encoding.

Parameters:

dataUrl - data:URL-like string (may be quoted)

Returns:

extracted byte array or null if it cannot be extracted.

decode

public static java.lang.String decode(java.lang.String string)

parseHostFromSshUrl

public static java.lang.String parseHostFromSshUrl(java.lang.String sshUrl)

getJarEntryURL

public static java.net.URL getJarEntryURL(java.io.File file,
                                          java.lang.String pathInJar)
                                   throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

getJarEntryURL

public static java.net.URL getJarEntryURL(java.net.URI file,
                                          java.lang.String pathInJar)
                                   throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

getJarEntryUri

public static java.net.URI getJarEntryUri(java.net.URI file,
                                          java.lang.String pathInJar)
                                   throws java.net.URISyntaxException

Throws:

java.net.URISyntaxException

encodeURIComponent

public static java.lang.String encodeURIComponent(java.lang.String s)

Encodes a URI component by replacing each instance of certain characters by one, two, three, or four escape sequences representing the UTF-8 encoding of the character. Behaves similarly to standard JavaScript build-in function encodeURIComponent.

Parameters:

s - a component of a URI

Returns:

a new string representing the provided string encoded as a URI component

findUrl

public static TextRange findUrl(java.lang.CharSequence text,
                                int startOffset,
                                int endOffset)

Finds the first range in text containing URL. This is similar to using URL_PATTERN matcher, but also finds URLs containing matched set of parentheses.