net.sourceforge.cruisecontrol.sourcecontrols
Class CMSynergyModification

java.lang.Object
  extended bynet.sourceforge.cruisecontrol.Modification
      extended bynet.sourceforge.cruisecontrol.sourcecontrols.CMSynergyModification
All Implemented Interfaces:
java.lang.Comparable, java.io.Serializable

public class CMSynergyModification
extends Modification

Data structure which holds data specific to a single modification within a CM Synergy repository.

Author:
Robert J. Smith
See Also:
Serialized Form

Nested Class Summary
 class CMSynergyModification.ChangeRequest
          Data structure which holds data specific to a Change Request associated with a modification within a CM Synergy repository.
 class CMSynergyModification.ModifiedObject
          Data structure which holds data specific to a single object included in a modification within a CM Synergy repository.
 
Nested classes inherited from class net.sourceforge.cruisecontrol.Modification
Modification.ModifiedFile
 
Field Summary
 java.util.List changeRequests
          A list of change requests associated with this modification
 java.lang.String taskNumber
          The CM Synergy task number represented by this modification
 
Fields inherited from class net.sourceforge.cruisecontrol.Modification
comment, emailAddress, files, modifiedTime, revision, type, userName
 
Constructor Summary
CMSynergyModification()
          Creates a new CMSynergyModification object and sets it's modification type to "ccmtask".
 
Method Summary
 CMSynergyModification.ChangeRequest createChangeRequest(java.lang.String number)
          Creates a new ChangeRequest, and adds it to the list of change requests associated with the task.
 CMSynergyModification.ModifiedObject createModifiedObject()
          Creates a new ModifiedObject, and adds it to the list of CM Synergy objects associated with the task.
 CMSynergyModification.ModifiedObject createModifiedObject(java.lang.String name, java.lang.String version, java.lang.String type, java.lang.String instance, java.lang.String project, java.lang.String comment)
          Creates a new ModifiedObject, populates the fields, and adds it to the list of CM Synergy objects associated with the task.
 boolean equals(java.lang.Object o)
           
 void fromElement(org.jdom.Element modification, java.text.DateFormat formatter)
           
 void log(java.text.DateFormat formatter)
           
 org.jdom.Element toElement(java.text.DateFormat formatter)
           
 java.lang.String toString()
           
 
Methods inherited from class net.sourceforge.cruisecontrol.Modification
compareTo, createModifiedFile, getFileName, getFolderName, getFullPath, getModifiedFiles, hashCode, newModifiedFile, toXml
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

taskNumber

public java.lang.String taskNumber
The CM Synergy task number represented by this modification


changeRequests

public java.util.List changeRequests
A list of change requests associated with this modification

Constructor Detail

CMSynergyModification

public CMSynergyModification()
Creates a new CMSynergyModification object and sets it's modification type to "ccmtask".

Method Detail

createModifiedObject

public final CMSynergyModification.ModifiedObject createModifiedObject()
Creates a new ModifiedObject, and adds it to the list of CM Synergy objects associated with the task.

Returns:
A new ModifiedObject

createModifiedObject

public final CMSynergyModification.ModifiedObject createModifiedObject(java.lang.String name,
                                                                       java.lang.String version,
                                                                       java.lang.String type,
                                                                       java.lang.String instance,
                                                                       java.lang.String project,
                                                                       java.lang.String comment)
Creates a new ModifiedObject, populates the fields, and adds it to the list of CM Synergy objects associated with the task.

Parameters:
name - The object's name
version - The object's version
type - The object's type within CM Synergy
instance - The object's instance
project - The project with which the object is associated
comment - The comment provided when checking in the object
Returns:
A new ModifiedObject

createChangeRequest

public final CMSynergyModification.ChangeRequest createChangeRequest(java.lang.String number)
Creates a new ChangeRequest, and adds it to the list of change requests associated with the task.

Parameters:
number - The CR number
Returns:
A new ChangeRequest

toElement

public org.jdom.Element toElement(java.text.DateFormat formatter)
Overrides:
toElement in class Modification

toString

public java.lang.String toString()
Overrides:
toString in class Modification

log

public void log(java.text.DateFormat formatter)
Overrides:
log in class Modification

fromElement

public void fromElement(org.jdom.Element modification,
                        java.text.DateFormat formatter)
Overrides:
fromElement in class Modification

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class Modification