com.microsoft.tfs.core.clients.versioncontrol.soapextensions
Class CheckinNote

java.lang.Object
  extended by com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
      extended by com.microsoft.tfs.core.clients.versioncontrol.soapextensions.CheckinNote

public class CheckinNote
extends com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

Contains supplemental information (possibly required, depending on team project configuration) provided by the user during checkin which becomes part of a Changeset.

Since:
TEE-SDK-10.1

Field Summary
static int CHECKIN_NOTE_NAME_MAX_SIZE_CHARS
          The maximum size allowed for checkin note names.
static java.lang.String XML_CHECKIN_NOTES
           
static java.lang.String XML_NOTE
           
static java.lang.String XML_NOTE_NAME
           
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Constructor Summary
CheckinNote(ms.tfs.versioncontrol.clientservices._03._CheckinNote checkinNote)
           
CheckinNote()
           
CheckinNote(CheckinNoteFieldValue[] values)
           
 
Method Summary
static java.lang.String canonicalizeName(java.lang.String name)
          Check if the specified string is a valid checkin note name and strip any leading and trailing whitespace characters.
 CheckinNoteFieldValue[] getValues()
           
 ms.tfs.versioncontrol.clientservices._03._CheckinNote getWebServiceObject()
          Gets the web service object this class wraps.
 java.util.Iterator iterator()
          Get an iterator over the array of CheckInNoteFieldValues.
static CheckinNote loadFromXML(org.w3c.dom.Element checkinNoteNode)
          Creates an instance from the XML representation used in the cache file.
 void saveAsXML(org.w3c.dom.Element parent)
          Saves this instance to the XML format used in the cache file.
 
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
equals, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

XML_CHECKIN_NOTES

public static final java.lang.String XML_CHECKIN_NOTES
Constant Field Value:
"CheckinNotes"
See Also:
Constant Field Values

XML_NOTE

public static final java.lang.String XML_NOTE
Constant Field Value:
"Note"
See Also:
Constant Field Values

XML_NOTE_NAME

public static final java.lang.String XML_NOTE_NAME
Constant Field Value:
"name"
See Also:
Constant Field Values

CHECKIN_NOTE_NAME_MAX_SIZE_CHARS

public static final int CHECKIN_NOTE_NAME_MAX_SIZE_CHARS
The maximum size allowed for checkin note names.

Constant Field Value:
64
See Also:
Constant Field Values
Constructor Detail

CheckinNote

public CheckinNote()

CheckinNote

public CheckinNote(ms.tfs.versioncontrol.clientservices._03._CheckinNote checkinNote)

CheckinNote

public CheckinNote(CheckinNoteFieldValue[] values)
Method Detail

getWebServiceObject

public ms.tfs.versioncontrol.clientservices._03._CheckinNote getWebServiceObject()
Gets the web service object this class wraps. The returned object should not be modified.

Returns:
the web service object this class wraps.

canonicalizeName

public static java.lang.String canonicalizeName(java.lang.String name)
Check if the specified string is a valid checkin note name and strip any leading and trailing whitespace characters. Throw an exception if the name is invalid.

Parameters:
name - String containing checkin note name.
Returns:
Canonicalized name String.

getValues

public CheckinNoteFieldValue[] getValues()

iterator

public java.util.Iterator iterator()
Get an iterator over the array of CheckInNoteFieldValues.


loadFromXML

public static CheckinNote loadFromXML(org.w3c.dom.Element checkinNoteNode)
Creates an instance from the XML representation used in the cache file.

Parameters:
checkinNoteNode - the check notes node (must not be null)

saveAsXML

public void saveAsXML(org.w3c.dom.Element parent)
Saves this instance to the XML format used in the cache file.



© 2015 Microsoft. All rights reserved.