com.tridion.util

Class TCMURI

java.lang.Object

com.tridion.util.CMURI

com.tridion.util.TCMURI

All Implemented Interfaces:

Comparable<CMURI>

public class TCMURI
extends CMURI

This class represents a TCMURI object.

This object is a helper object used to parse and create UDP URIs.

Field Summary

Fields

Modifier and Type	Field and Description
static TCMURI	NULL_URI Null TCM URI.
static String	URI_NAMESPACE URI namespace.

Constructor Summary

Constructors

Constructor and Description
TCMURI(int publicationId, int itemId, int itemType, int version) Create a new 'tcm:' namespace URI based on publication Id, item Id, item type and version.
TCMURI(String uri) Create a new 'tcm:' namespace URI from a string.

Method Summary

Modifier and Type	Method and Description
String	getNamespace()
protected boolean	isNullUri() Check if this object is NULL_URI.

Methods inherited from class com.tridion.util.CMURI

compareTo, equals, getItemId, getItemType, getPublicationId, getVersion, hashCode, load, setItemId, setItemType, setNamespace, setPublicationId, setVersion, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

URI_NAMESPACE

public static final String URI_NAMESPACE

URI namespace.

See Also:

Constant Field Values

NULL_URI

public static final TCMURI NULL_URI

Null TCM URI.

Constructor Detail

TCMURI

public TCMURI(int publicationId,
              int itemId,
              int itemType,
              int version)

Create a new 'tcm:' namespace URI based on publication Id, item Id, item type and version.

Parameters:

publicationId - publicationId for this URI.

itemId - itemId for this URI.

itemType - itemType for this URI.

version - version for this URI.

See Also:

ItemTypes

TCMURI

public TCMURI(String uri)
       throws ParseException

Create a new 'tcm:' namespace URI from a string.

Parameters:

uri - String containing the URI to be parsed.

Throws:

ParseException - Thrown if the String does not contain a valid TCMURI

Method Detail

getNamespace

public String getNamespace()

Overrides:

getNamespace in class CMURI

isNullUri

protected boolean isNullUri()

Description copied from class: CMURI

Check if this object is NULL_URI.

Overrides:

isNullUri in class CMURI

Returns:

true if this object is NULL_URI, false otherwise.