com.microsoft.tfs.core.clients.workitem.query
Class WIQDocument
java.lang.Object
com.microsoft.tfs.core.clients.workitem.query.WIQDocument
public class WIQDocument
- extends java.lang.Object
A WIQDocument
represents a specific type of document used to store
work item query information. A WIQDocument
is closely tied to its
default serialized form, which is an XML document. XML documents in this
format are usually stored as files with a .wiq extension, which is where the
name of this class comes from.
A WIQDocument
at minimum contains a non-null
WIQL string
and an integer version. There are also several other pieces of optional
information that a WIQDocument
may contain.
A WIQDocument
is immutable and threadsafe, and is an in-memory
representation of the query data.
You can construct a WIQDocument
by passing individual data values to
a constructor, or you can call static methods to load a WIQDocument
from a File
(load(File)
) or XML Document
(
load(Document)
).
You can produce an XML Document
from a WIQDocument
by calling
toXMLDocument()
, and you can serialize a WIQDocument
to a
File
by calling save(File)
.
- Since:
- TEE-SDK-10.1
Constructor Summary |
WIQDocument(java.lang.String wiql,
java.lang.String teamFoundationServer,
java.lang.String teamProject,
java.lang.String teamName)
|
WIQDocument(java.lang.String wiql,
java.lang.String teamFoundationServer,
java.lang.String teamProject,
java.lang.String teamName,
int version)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
WIQDocument
public WIQDocument(java.lang.String wiql,
java.lang.String teamFoundationServer,
java.lang.String teamProject,
java.lang.String teamName)
WIQDocument
public WIQDocument(java.lang.String wiql,
java.lang.String teamFoundationServer,
java.lang.String teamProject,
java.lang.String teamName,
int version)
load
public static WIQDocument load(java.io.File file)
throws WIQDocumentParseException
- Throws:
WIQDocumentParseException
load
public static WIQDocument load(org.w3c.dom.Document document)
throws WIQDocumentParseException
- Throws:
WIQDocumentParseException
getWIQL
public java.lang.String getWIQL()
getTeamFoundationServer
public java.lang.String getTeamFoundationServer()
getTeamProject
public java.lang.String getTeamProject()
getTeamName
public java.lang.String getTeamName()
getVersion
public int getVersion()
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object
toXMLDocument
public org.w3c.dom.Document toXMLDocument()
save
public void save(java.io.File file)
© 2015 Microsoft. All rights reserved.