Package org.eclipse.jgit.lib

Class UserConfig

java.lang.Object

org.eclipse.jgit.lib.UserConfig

public class UserConfig
extends Object

The standard "user" configuration parameters.

Field Summary

Fields

Modifier and Type	Field	Description
static Config.SectionParser<UserConfig>	KEY	Key for Config.get(SectionParser).

Method Summary

Modifier and Type	Method	Description
String	getAuthorEmail()	Get the author email as defined in git variables and configurations.
String	getAuthorName()	Get the author name as defined in the git variables and configurations.
String	getCommitterEmail()	Get the committer email as defined in git variables and configurations.
String	getCommitterName()	Get the committer name as defined in the git variables and configurations.
boolean	isAuthorEmailImplicit()	Whether the author email was not explicitly configured but constructed from information the system has about the logged on user
boolean	isAuthorNameImplicit()	Whether the author name was not explicitly configured but constructed from information the system has about the logged on user
boolean	isCommitterEmailImplicit()	Whether the author email was not explicitly configured but constructed from information the system has about the logged on user
boolean	isCommitterNameImplicit()	Whether the committer name was not explicitly configured but constructed from information the system has about the logged on user

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final Config.SectionParser<UserConfig> KEY

Key for Config.get(SectionParser).

Method Detail

getAuthorName

public String getAuthorName()

Get the author name as defined in the git variables and configurations.

Returns:

the author name as defined in the git variables and configurations. If no name could be found, try to use the system user name instead.

getCommitterName

public String getCommitterName()

Get the committer name as defined in the git variables and configurations.

Returns:

the committer name as defined in the git variables and configurations. If no name could be found, try to use the system user name instead.

getAuthorEmail

public String getAuthorEmail()

Get the author email as defined in git variables and configurations.

Returns:

the author email as defined in git variables and configurations. If no email could be found, try to propose one default with the user name and the host name.

getCommitterEmail

public String getCommitterEmail()

Get the committer email as defined in git variables and configurations.

Returns:

the committer email as defined in git variables and configurations. If no email could be found, try to propose one default with the user name and the host name.

isAuthorNameImplicit

public boolean isAuthorNameImplicit()

Whether the author name was not explicitly configured but constructed from information the system has about the logged on user

Returns:

true if the author name was not explicitly configured but constructed from information the system has about the logged on user

isAuthorEmailImplicit

public boolean isAuthorEmailImplicit()

Whether the author email was not explicitly configured but constructed from information the system has about the logged on user

Returns:

true if the author email was not explicitly configured but constructed from information the system has about the logged on user

isCommitterNameImplicit

public boolean isCommitterNameImplicit()

Whether the committer name was not explicitly configured but constructed from information the system has about the logged on user

Returns:

true if the committer name was not explicitly configured but constructed from information the system has about the logged on user

isCommitterEmailImplicit

public boolean isCommitterEmailImplicit()

Whether the author email was not explicitly configured but constructed from information the system has about the logged on user

Returns:

true if the author email was not explicitly configured but constructed from information the system has about the logged on user