Package io.gitea.model

Class DeleteFileOptions

java.lang.Object

io.gitea.model.DeleteFileOptions

public class DeleteFileOptions
extends java.lang.Object

DeleteFileOptions options for deleting files (used for other File structs below) Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)

Constructor Summary

Constructors

Constructor	Description
DeleteFileOptions()

Method Summary

Modifier and Type	Method	Description
DeleteFileOptions	author(Identity author)
DeleteFileOptions	branch(java.lang.String branch)
DeleteFileOptions	committer(Identity committer)
DeleteFileOptions	dates(CommitDateOptions dates)
boolean	equals(java.lang.Object o)
Identity	getAuthor()	Get author
java.lang.String	getBranch()	branch (optional) to base this file from.
Identity	getCommitter()	Get committer
CommitDateOptions	getDates()	Get dates
java.lang.String	getMessage()	message (optional) for the commit of this file.
java.lang.String	getNewBranch()	new_branch (optional) will make a new branch from `branch` before creating the file
java.lang.String	getSha()	sha is the SHA for the file that already exists
int	hashCode()
java.lang.Boolean	isSignoff()	Add a Signed-off-by trailer by the committer at the end of the commit log message.
DeleteFileOptions	message(java.lang.String message)
DeleteFileOptions	newBranch(java.lang.String newBranch)
void	setAuthor(Identity author)
void	setBranch(java.lang.String branch)
void	setCommitter(Identity committer)
void	setDates(CommitDateOptions dates)
void	setMessage(java.lang.String message)
void	setNewBranch(java.lang.String newBranch)
void	setSha(java.lang.String sha)
void	setSignoff(java.lang.Boolean signoff)
DeleteFileOptions	sha(java.lang.String sha)
DeleteFileOptions	signoff(java.lang.Boolean signoff)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DeleteFileOptions

public DeleteFileOptions()

Method Details

author

public DeleteFileOptions author(Identity author)

getAuthor

public Identity getAuthor()

Get author

Returns:

author

setAuthor

public void setAuthor(Identity author)

branch

public DeleteFileOptions branch(java.lang.String branch)

getBranch

public java.lang.String getBranch()

branch (optional) to base this file from. if not given, the default branch is used

Returns:

branch

setBranch

public void setBranch(java.lang.String branch)

committer

public DeleteFileOptions committer(Identity committer)

getCommitter

public Identity getCommitter()

Get committer

Returns:

committer

setCommitter

public void setCommitter(Identity committer)

dates

public DeleteFileOptions dates(CommitDateOptions dates)

getDates

public CommitDateOptions getDates()

Get dates

Returns:

dates

setDates

public void setDates(CommitDateOptions dates)

message

public DeleteFileOptions message(java.lang.String message)

getMessage

public java.lang.String getMessage()

message (optional) for the commit of this file. if not supplied, a default message will be used

Returns:

message

setMessage

public void setMessage(java.lang.String message)

newBranch

public DeleteFileOptions newBranch(java.lang.String newBranch)

getNewBranch

public java.lang.String getNewBranch()

new_branch (optional) will make a new branch from `branch` before creating the file

Returns:

newBranch

setNewBranch

public void setNewBranch(java.lang.String newBranch)

sha

public DeleteFileOptions sha(java.lang.String sha)

getSha

public java.lang.String getSha()

sha is the SHA for the file that already exists

Returns:

sha

setSha

public void setSha(java.lang.String sha)

signoff

public DeleteFileOptions signoff(java.lang.Boolean signoff)

isSignoff

public java.lang.Boolean isSignoff()

Add a Signed-off-by trailer by the committer at the end of the commit log message.

Returns:

signoff

setSignoff

public void setSignoff(java.lang.Boolean signoff)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object