core

Type Members

1. case class RepositoryCommitIdentity(date: Date, name: String, email: String) extends Product with Serializable

   

   A data structure representing the identitiy of someone mentioned in commit data.

   A data structure representing the identitiy of someone mentioned in commit data. This is typically used to identify the author and committer.

   date

   The timestamp for when the person touched the commit.

   name

   The name of the person.

   email

   The email address of the person.

2. case class RepositoryCommitSummary(sha: String, author: RepositoryCommitIdentity, committer: RepositoryCommitIdentity, message: String) extends Product with Serializable

   

   A data structure representing a summary of a commit in the repository.

   A data structure representing a summary of a commit in the repository.

   The sha will identifiy the full SHA hash of the commit. The message will be the full message that the author wrote - including expanded content. If you wish to only show the headline (commonly known as the short message) you can parse out the first line of content.

   sha

   The sha identifier of the commit.

   author

   The person who authored the commit.

   committer

   The person who committed the commit into the repo.

   message

   The message associated with the commit.

3. case class RepositoryCommitSummaryPage(ref: String, totalCommitCount: Int, skip: Int, maxCount: Int, commits: List[RepositoryCommitSummary]) extends Product with Serializable

   

   A data structure representing a page of commits from the repository.

   A data structure representing a page of commits from the repository.

   ref

   The ref that this commit summary page is browsing.

   totalCommitCount

   The total number of commits on this ref.

   skip

   The number of commits skipped before the beginning of this page.

   maxCount

   The maximum number of commits that could be in this page.

   commits

   The commits for this page.

4. case class RepositoryFileContent(name: String, content: String, encoding: String, size: Long) extends Product with Serializable

   

   A data structure representing the file content of a file within the repository.

   A data structure representing the file content of a file within the repository.

   This data structure is only capable of representing files up to the available memory limit of the JVM. The underlying implementation (provided by JGit's ObjectLoader) works a little empirically by attempting to allocate a byte array large enough to hold the file and catching an OutOfMemoryError if one occurs during that attempt.

   If we are able to create this data structure, it will contain the content encoded in the specified encoding - which will either be "base64" or "utf8".

   name

   The name of the file.

   content

   The content of the file.

   encoding

   The encoding used for the content of the file. Either base64 or utf-8.

   size

   The size of the file.

5. case class RepositoryFileSummary(name: String, path: String, mode: String, isDirectory: Boolean, size: Long) extends Product with Serializable

   

   A data structure representing the summary of a file in a repository.

   A data structure representing the summary of a file in a repository.

   This summary includes all the information you might find if you were using ls on a directory on your local file system. Specifically, the name of the file, its path in the overall repository, the permissions associated with it (mode), whether or not it is a directory, and its total size.

   name

   The name of the file.

   path

   The path of the file.

   mode

   The permissions on the file when it's expanded.

   isDirectory

   True if this is a directory. False for a normal file.

   size

   The size of the actual file.

6. case class RepositorySummary(name: String, fullName: String, description: String) extends Product with Serializable

   

   A data structure providing a brief summary of a repository.

   A data structure providing a brief summary of a repository.

   name

   The short name of the repository.

   fullName

   The full path to the repository on the repository server.

   description

   The human description of the repository