Class UserConfig

java.lang.Object
org.eclipse.jgit.lib.UserConfig

public class UserConfig extends Object
The standard "user" configuration parameters.
  • Field Details

    • KEY

      public static final Config.SectionParser<UserConfig> KEY
    • authorName

      private String authorName
    • authorEmail

      private String authorEmail
    • committerName

      private String committerName
    • committerEmail

      private String committerEmail
    • isAuthorNameImplicit

      private boolean isAuthorNameImplicit
    • isAuthorEmailImplicit

      private boolean isAuthorEmailImplicit
    • isCommitterNameImplicit

      private boolean isCommitterNameImplicit
    • isCommitterEmailImplicit

      private boolean isCommitterEmailImplicit
  • Constructor Details

    • UserConfig

      private UserConfig(Config rc)
  • Method Details

    • 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
    • getNameInternal

      private static String getNameInternal(Config rc, String envKey)
    • getDefaultUserName

      private static String getDefaultUserName()
      Returns:
      try to get user name of the logged on user from the operating system
    • getEmailInternal

      private static String getEmailInternal(Config rc, String envKey)
    • stripInvalidCharacters

      private static String stripInvalidCharacters(String s)
    • getDefaultEmail

      private static String getDefaultEmail()
      Returns:
      try to construct email for logged on user using system information
    • system

      private static SystemReader system()