com.atlassian.crucible.spi.data
Class FisheyeReviewItemData

java.lang.Object
  extended by com.atlassian.crucible.spi.data.ReviewItemData
      extended by com.atlassian.crucible.spi.data.FisheyeReviewItemData
All Implemented Interfaces:
java.io.Serializable

public class FisheyeReviewItemData
extends ReviewItemData

A bean containg the attributes of a change in a review

See Also:
Serialized Form

Nested Class Summary
static class FisheyeReviewItemData.CommitType
           
static class FisheyeReviewItemData.FileType
           
static class FisheyeReviewItemData.ReviewItemRevisions
           
 
Field Summary
 
Fields inherited from class com.atlassian.crucible.spi.data.ReviewItemData
permId
 
Constructor Summary
FisheyeReviewItemData()
           
FisheyeReviewItemData(java.lang.String repositoryName, java.lang.String fromPath, java.lang.String fromRevision, java.lang.String toPath, java.lang.String toRevision, java.lang.Boolean showAsDiff)
           
FisheyeReviewItemData(java.lang.String repositoryName, java.lang.String fromPath, java.lang.String fromRevision, java.lang.String toPath, java.lang.String toRevision, java.lang.String permId)
           
FisheyeReviewItemData(java.lang.String repositoryName, java.lang.String fromPath, java.lang.String fromRevision, java.lang.String fromContentUrl, java.lang.String toPath, java.lang.String toRevision, java.lang.String toContentUrl, FisheyeReviewItemAttibutes attrs, java.lang.String permId, java.lang.String patchUrl, FisheyeReviewItemData.FileType fileType, java.lang.String authorName, java.util.Date commitDate, java.lang.Boolean showAsDiff)
           
 
Method Summary
 java.lang.String getAuthorName()
           
 java.util.Date getCommitDate()
           
 FisheyeReviewItemData.CommitType getCommitType()
           
 java.util.Collection<ReviewItemRevisionData> getExpandedRevisions()
          This method is a convenience method for plugins to obtain the list of revisions.
 FisheyeReviewItemData.FileType getFileType()
           
 java.lang.String getFromContentUrl()
          Returns the URI that points to the location of the raw content for the previous revision of this item.
 java.lang.String getFromPath()
           
 java.lang.String getFromRevision()
           
 java.lang.String getPatchUrl()
           
 java.lang.String getRepositoryName()
           
 FisheyeReviewItemData.ReviewItemRevisions getRevisions()
          This method returns the wrapper object that wraps a list of ReviewItemRevisionData.
 java.lang.String getToContentUrl()
          Returns the URI that points to the location of the raw content for the current revision of this item.
 java.lang.String getToPath()
           
 java.lang.String getToRevision()
           
 java.lang.Boolean isShowAsDiff()
           
 void setAuthorName(java.lang.String authorName)
           
 void setCommitDate(java.util.Date commitDate)
           
 void setCommitType(FisheyeReviewItemData.CommitType commitType)
           
 void setFileType(FisheyeReviewItemData.FileType fileType)
           
 void setFromContentUrl(java.lang.String fromContentUrl)
          Sets the URI that points to the location of the raw content for the previous revision of this item.
 void setFromPath(java.lang.String fromPath)
           
 void setFromRevision(java.lang.String fromRevision)
           
 void setPatchUrl(java.lang.String patchUrl)
           
 void setRepositoryName(java.lang.String repositoryName)
           
 void setRevisions(FisheyeReviewItemData.ReviewItemRevisions revisions)
           
 void setShowAsDiff(java.lang.Boolean showAsDiff)
           
 void setToContentUrl(java.lang.String toContentUrl)
          Sets the URI that points to the location of the raw content for the current revision of this item.
 void setToPath(java.lang.String toPath)
           
 void setToRevision(java.lang.String toRevision)
           
 
Methods inherited from class com.atlassian.crucible.spi.data.ReviewItemData
getPermId, setPermId, setPermIdAsString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FisheyeReviewItemData

public FisheyeReviewItemData()

FisheyeReviewItemData

public FisheyeReviewItemData(java.lang.String repositoryName,
                             java.lang.String fromPath,
                             java.lang.String fromRevision,
                             java.lang.String toPath,
                             java.lang.String toRevision,
                             java.lang.Boolean showAsDiff)

FisheyeReviewItemData

public FisheyeReviewItemData(java.lang.String repositoryName,
                             java.lang.String fromPath,
                             java.lang.String fromRevision,
                             java.lang.String toPath,
                             java.lang.String toRevision,
                             java.lang.String permId)

FisheyeReviewItemData

public FisheyeReviewItemData(java.lang.String repositoryName,
                             java.lang.String fromPath,
                             java.lang.String fromRevision,
                             java.lang.String fromContentUrl,
                             java.lang.String toPath,
                             java.lang.String toRevision,
                             java.lang.String toContentUrl,
                             FisheyeReviewItemAttibutes attrs,
                             java.lang.String permId,
                             java.lang.String patchUrl,
                             FisheyeReviewItemData.FileType fileType,
                             java.lang.String authorName,
                             java.util.Date commitDate,
                             java.lang.Boolean showAsDiff)
Method Detail

getRevisions

public FisheyeReviewItemData.ReviewItemRevisions getRevisions()
This method returns the wrapper object that wraps a list of ReviewItemRevisionData. If you are not in a REST call, you should use the getExpandedRevisions() call instead of this one, as the REST api performs list expansion on FisheyeReviewItemData.ReviewItemRevisions, and thus FisheyeReviewItemData.ReviewItemRevisions.getRevisions() will return null if you are using this method outside a REST api call.


getExpandedRevisions

public java.util.Collection<ReviewItemRevisionData> getExpandedRevisions()
This method is a convenience method for plugins to obtain the list of revisions. Call this instead of getRevisions() if you are not using the REST interface.


setRevisions

public void setRevisions(FisheyeReviewItemData.ReviewItemRevisions revisions)

getRepositoryName

public java.lang.String getRepositoryName()

getFromPath

public java.lang.String getFromPath()

getFromRevision

public java.lang.String getFromRevision()

getToPath

public java.lang.String getToPath()

setRepositoryName

public void setRepositoryName(java.lang.String repositoryName)

setFromPath

public void setFromPath(java.lang.String fromPath)

setFromRevision

public void setFromRevision(java.lang.String fromRevision)

setToPath

public void setToPath(java.lang.String toPath)

setToRevision

public void setToRevision(java.lang.String toRevision)

getToRevision

public java.lang.String getToRevision()

getPatchUrl

public java.lang.String getPatchUrl()

setPatchUrl

public void setPatchUrl(java.lang.String patchUrl)

getFileType

public FisheyeReviewItemData.FileType getFileType()

setFileType

public void setFileType(FisheyeReviewItemData.FileType fileType)

getCommitType

public FisheyeReviewItemData.CommitType getCommitType()

setCommitType

public void setCommitType(FisheyeReviewItemData.CommitType commitType)

getAuthorName

public java.lang.String getAuthorName()

setAuthorName

public void setAuthorName(java.lang.String authorName)

getCommitDate

public java.util.Date getCommitDate()

setCommitDate

public void setCommitDate(java.util.Date commitDate)

isShowAsDiff

public java.lang.Boolean isShowAsDiff()

setShowAsDiff

public void setShowAsDiff(java.lang.Boolean showAsDiff)

getFromContentUrl

public java.lang.String getFromContentUrl()
Returns the URI that points to the location of the raw content for the previous revision of this item.

Returns:
the URI that points to the location of the raw content for the previous revision of this item.

setFromContentUrl

public void setFromContentUrl(java.lang.String fromContentUrl)
Sets the URI that points to the location of the raw content for the previous revision of this item.

Parameters:
fromContentUrl - the URI that points to the location of the raw content for the previous revision of this item.

getToContentUrl

public java.lang.String getToContentUrl()
Returns the URI that points to the location of the raw content for the current revision of this item.

Returns:
the URI that points to the location of the raw content for the current revision of this item.

setToContentUrl

public void setToContentUrl(java.lang.String toContentUrl)
Sets the URI that points to the location of the raw content for the current revision of this item.

Parameters:
toContentUrl - the URI that points to the location of the raw content for the current revision of this item.