Package org.kohsuke.github

Class GitUser

java.lang.Object

org.kohsuke.github.GitUser

Direct Known Subclasses:

GHCommit.GHAuthor, GHCompare.User, GHPullRequestCommitDetail.Authorship

public class GitUser
extends Object

Represents a user in Git who authors/commits a commit.

In contrast, GHUser is an user of GitHub. Because Git allows a person to use multiple e-mail addresses and names when creating a commit, there's generally no meaningful mapping between GHUser and GitUser.

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor	Description
GitUser()

Method Summary

Modifier and Type	Method	Description
Date	getDate()	Gets date.
String	getEmail()	Gets the git email for an author or committer on a git commit.
String	getName()	Gets the git user name for an author or committer on a git commit.
String	getUsername()	Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitUser

public GitUser()

Method Detail

getName

public String getName()

Gets the git user name for an author or committer on a git commit.

Returns:

Human readable name of the user, such as "Kohsuke Kawaguchi"

getEmail

public String getEmail()

Gets the git email for an author or committer on a git commit.

Returns:

E-mail address, such as "foo@example.com"

getUsername

@Preview
@Deprecated
@CheckForNull
public String getUsername()

Deprecated.

Gets username. Note: it presents only in events.

Returns:

GitHub username

getDate

public Date getDate()

Gets date.

Returns:

This field doesn't appear to be consistently available in all the situations where this class is used.