public class CommitBuilder extends Object
CommitCommand.
To read a commit object, construct a RevWalk
and obtain a RevCommit instance by calling
RevWalk.parseCommit(AnyObjectId).| Constructor and Description |
|---|
CommitBuilder()
Initialize an empty commit.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addParentId(AnyObjectId additionalParent)
Add a parent onto the end of the parent list.
|
byte[] |
build()
Format this builder's state as a commit object.
|
PersonIdent |
getAuthor() |
PersonIdent |
getCommitter() |
Charset |
getEncoding() |
String |
getMessage() |
ObjectId[] |
getParentIds() |
ObjectId |
getTreeId() |
void |
setAuthor(PersonIdent newAuthor)
Set the author (name, email address, and date) of who wrote the commit.
|
void |
setCommitter(PersonIdent newCommitter)
Set the committer and commit time for this object
|
void |
setEncoding(Charset enc)
Set the encoding for the commit information
|
void |
setEncoding(String encodingName)
Set the encoding for the commit information
|
void |
setMessage(String newMessage)
Set the commit message.
|
void |
setParentId(AnyObjectId newParent)
Set the parent of this commit.
|
void |
setParentIds(AnyObjectId parent1,
AnyObjectId parent2)
Set the parents of this commit.
|
void |
setParentIds(List<? extends AnyObjectId> newParents)
Set the parents of this commit.
|
void |
setParentIds(ObjectId... newParents)
Set the parents of this commit.
|
void |
setTreeId(AnyObjectId id)
Set the tree id for this commit object
|
byte[] |
toByteArray()
Format this builder's state as a commit object.
|
String |
toString() |
public ObjectId getTreeId()
public void setTreeId(AnyObjectId id)
id - the tree identity.public PersonIdent getAuthor()
public void setAuthor(PersonIdent newAuthor)
newAuthor - the new author. Should not be null.public PersonIdent getCommitter()
public void setCommitter(PersonIdent newCommitter)
newCommitter - the committer information. Should not be null.public ObjectId[] getParentIds()
public void setParentId(AnyObjectId newParent)
newParent - the single parent for the commit.public void setParentIds(AnyObjectId parent1, AnyObjectId parent2)
parent1 - the first parent of this commit. Typically this is the current
value of the HEAD reference and is thus the current
branch's position in history.parent2 - the second parent of this merge commit. Usually this is the
branch being merged into the current branch.public void setParentIds(ObjectId... newParents)
newParents - the entire list of parents for this commit.public void setParentIds(List<? extends AnyObjectId> newParents)
newParents - the entire list of parents for this commit.public void addParentId(AnyObjectId additionalParent)
additionalParent - new parent to add onto the end of the current parent list.public String getMessage()
public void setMessage(String newMessage)
newMessage - the commit message. Should not be null.public void setEncoding(String encodingName)
encodingName - the encoding name. See Charset.forName(String).public void setEncoding(Charset enc)
enc - the encoding to use.public Charset getEncoding()
public byte[] build()
throws UnsupportedEncodingException
UnsupportedEncodingException - the encoding specified by getEncoding() is not
supported by this Java runtime.public byte[] toByteArray()
throws UnsupportedEncodingException
UnsupportedEncodingException - the encoding specified by getEncoding() is not
supported by this Java runtime.Copyright © 2014. All rights reserved.