com.tridion.util

Class URIUtils

java.lang.Object

com.tridion.util.URIUtils

public class URIUtils
extends Object

Utility class for manipulating URI's (specifically TCMURI's and TCDURI's.

Method Summary

Modifier and Type	Method and Description
static String	createFileSafeName(String tcmURI)
static String	createFileSafeName(TCDURI tcdURI) Converts a TCDURI into a string that can be used for a file name by replacing all non-file safe characters with file-safe characters.
static String	createFileSafeName(TCMURI tcmURI) Converts a TCMURI into a string that can be used for a file name by replacing all non-file safe characters with file-safe characters.
static TCDURI	createTCDURI(String fileSafeName) Creates a TCDURI from a file safe name by replacing special file safe characters with the "original" separators.
static TCMURI	createTCMURI(String fileSafeName) Creates a TCMURI from a file safe name by replacing special file safe characters with the "original" separators.
static char	getFileSafeTCDURIItemSeparator() Gets the file safe character that is used to replace "/" in TCDURI's.
static char	getFileSafeURISeparator() Gets the file safe character that is used to replace ":" in TCMURI's and TCDURI's.
static char	getUriSeparator() Gets the ":" uri separator.
static String	urlDecode(String text) URL decode a string.
static String	urlEncode(String text) URL encode a string.

Methods inherited from class java.lang.Object

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

Method Detail

createFileSafeName

public static String createFileSafeName(TCMURI tcmURI)

Converts a TCMURI into a string that can be used for a file name by replacing all non-file safe characters with file-safe characters.

Parameters:

tcmURI - The TCMURI to generate a file-safe string from.

Returns:

A file-safe string representation of the passed TCMURI.

createFileSafeName

public static String createFileSafeName(String tcmURI)

createTCMURI

public static TCMURI createTCMURI(String fileSafeName)
                           throws ParseException

Creates a TCMURI from a file safe name by replacing special file safe characters with the "original" separators.

Parameters:

fileSafeName - The file safe name.

Returns:

The created TCMURI.

Throws:

ParseException - If an error occurs creating the TCMURI.

createFileSafeName

public static String createFileSafeName(TCDURI tcdURI)

Converts a TCDURI into a string that can be used for a file name by replacing all non-file safe characters with file-safe characters.

Parameters:

tcdURI - The TCDURI to generate a file-safe string from.

Returns:

A file-safe string representation of the passed TCDURI.

createTCDURI

public static TCDURI createTCDURI(String fileSafeName)
                           throws ParseException

Creates a TCDURI from a file safe name by replacing special file safe characters with the "original" separators.

Parameters:

fileSafeName - The file safe name.

Returns:

The created TCDURI.

Throws:

ParseException - If an error occurs creating the TCDURI.

getFileSafeURISeparator

public static char getFileSafeURISeparator()

Gets the file safe character that is used to replace ":" in TCMURI's and TCDURI's.

Returns:

The file safe URI separator character.

getFileSafeTCDURIItemSeparator

public static char getFileSafeTCDURIItemSeparator()

Gets the file safe character that is used to replace "/" in TCDURI's.

Returns:

The file safe TCD URI item separator character.

getUriSeparator

public static char getUriSeparator()

Gets the ":" uri separator.

Returns:

The uri separator character.

urlEncode

public static String urlEncode(String text)

URL encode a string. This method catches UnsupportedEncodingException, which is a checked exception that should never happen, because UTF-8 is always supported.

Parameters:

text - The text to URL encode.

Returns:

The URL encoded text.

urlDecode

public static String urlDecode(String text)

URL decode a string. This method catches UnsupportedEncodingException, which is a checked exception that should never happen, because UTF-8 is always supported.

Parameters:

text - The text to URL decode.

Returns:

The URL decoded text.