|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.artifact.ArtifactID
public class ArtifactID
An artifact ID represents the unique, multi-part identifier of an object stored in one of the data repositories of a component of Team Foundation Server. Work items and version control changesets are examples of artifacts.
An artifact ID is composed of 3 parts:
An artifact ID can be represented by a URI. This URI is also known as a TFS URI or an artifact URI. The URI contains all 3 parts of an artifact ID in the following form:
vstfs:///tool/artifact-type/tool-specific-identifier
Field Summary | |
---|---|
static java.lang.String |
URI_SEPARATOR
The separator used to separate the various parts of the artifact id within a TFS URI. |
static java.lang.String |
VSTFS_PREFIX
The prefix that all well-formed TFS URIs begin with. |
Constructor Summary | |
---|---|
ArtifactID(java.lang.String uri)
Create a new artifact id from a TFS URI. |
|
ArtifactID(java.lang.String tool,
java.lang.String artifactType,
java.lang.String toolSpecificId)
Create a new artifact id by specifying each of the parts individually. |
Method Summary | |
---|---|
static void |
checkURIIsWellFormed(java.lang.String uri)
|
java.lang.String |
encodeURI()
Encodes this artifact id as a TFS URI. |
boolean |
equals(java.lang.Object obj)
|
java.lang.String |
getArtifactType()
|
java.lang.String |
getTool()
|
java.lang.String |
getToolSpecificID()
|
int |
hashCode()
|
boolean |
isWellFormed()
Checks whether this artifact id is well formed. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String VSTFS_PREFIX
"vstfs:///"
public static final java.lang.String URI_SEPARATOR
"/"
Constructor Detail |
---|
public ArtifactID(java.lang.String tool, java.lang.String artifactType, java.lang.String toolSpecificId)
tool
- the tool part of the artifact idartifactType
- the artifact type part of the artifact idtoolSpecificId
- the tool specific id part of the artifact idpublic ArtifactID(java.lang.String uri)
uri
- the uri to decode and create an artifact id from
MalformedURIException
- if the uri is not well-formedMethod Detail |
---|
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public static void checkURIIsWellFormed(java.lang.String uri)
public java.lang.String getTool()
public java.lang.String getArtifactType()
public java.lang.String getToolSpecificID()
public java.lang.String encodeURI()
MalformedArtifactIDException
- if this artifact id is not well-formedpublic boolean isWellFormed()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |