diff options
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/lib/UserConfig.java')
| -rw-r--r-- | org.eclipse.jgit/src/org/eclipse/jgit/lib/UserConfig.java | 88 |
1 files changed, 36 insertions, 52 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/UserConfig.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/UserConfig.java index b8d236c1da..b4a8cfa478 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/UserConfig.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/UserConfig.java @@ -1,46 +1,13 @@ /* * Copyright (C) 2009, Google Inc. * Copyright (C) 2009, Yann Simon <yann.simon.fr@gmail.com> - * Copyright (C) 2011, Matthias Sohn <matthias.sohn@sap.com> - * and other copyright owners as documented in the project's IP log. + * Copyright (C) 2011, Matthias Sohn <matthias.sohn@sap.com> and others * - * This program and the accompanying materials are made available - * under the terms of the Eclipse Distribution License v1.0 which - * accompanies this distribution, is reproduced below, and is - * available at http://www.eclipse.org/org/documents/edl-v10.php + * This program and the accompanying materials are made available under the + * terms of the Eclipse Distribution License v. 1.0 which is available at + * https://www.eclipse.org/org/documents/edl-v10.php. * - * All rights reserved. - * - * Redistribution and use in source and binary forms, with or - * without modification, are permitted provided that the following - * conditions are met: - * - * - Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * - * - Redistributions in binary form must reproduce the above - * copyright notice, this list of conditions and the following - * disclaimer in the documentation and/or other materials provided - * with the distribution. - * - * - Neither the name of the Eclipse Foundation, Inc. nor the - * names of its contributors may be used to endorse or promote - * products derived from this software without specific prior - * written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND - * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, - * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES - * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR - * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT - * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; - * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, - * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) - * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF - * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * SPDX-License-Identifier: BSD-3-Clause */ package org.eclipse.jgit.lib; @@ -48,14 +15,12 @@ package org.eclipse.jgit.lib; import org.eclipse.jgit.lib.Config.SectionParser; import org.eclipse.jgit.util.SystemReader; -/** The standard "user" configuration parameters. */ +/** + * The standard "user" configuration parameters. + */ public class UserConfig { /** Key for {@link Config#get(SectionParser)}. */ - public static final Config.SectionParser<UserConfig> KEY = new SectionParser<UserConfig>() { - public UserConfig parse(final Config cfg) { - return new UserConfig(cfg); - } - }; + public static final Config.SectionParser<UserConfig> KEY = UserConfig::new; private String authorName; @@ -73,7 +38,7 @@ public class UserConfig { private boolean isCommitterEmailImplicit; - private UserConfig(final Config rc) { + private UserConfig(Config rc) { authorName = getNameInternal(rc, Constants.GIT_AUTHOR_NAME_KEY); if (authorName == null) { authorName = getDefaultUserName(); @@ -98,6 +63,8 @@ public class UserConfig { } /** + * Get the author name as defined in the git variables and configurations. + * * @return 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. @@ -107,6 +74,9 @@ public class UserConfig { } /** + * Get the committer name as defined in the git variables and + * configurations. + * * @return 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. @@ -116,26 +86,31 @@ public class UserConfig { } /** - * @return 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. + * Get the author email as defined in git variables and configurations. + * + * @return 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. */ public String getAuthorEmail() { return authorEmail; } /** + * Get the committer email as defined in git variables and configurations. + * * @return 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. + * configurations. If no email could be found, try to propose one + * default with the user name and the host name. */ public String getCommitterEmail() { return committerEmail; } /** + * Whether the author name was not explicitly configured but constructed + * from information the system has about the logged on user + * * @return true if the author name was not explicitly configured but * constructed from information the system has about the logged on * user @@ -145,6 +120,9 @@ public class UserConfig { } /** + * Whether the author email was not explicitly configured but constructed + * from information the system has about the logged on user + * * @return true if the author email was not explicitly configured but * constructed from information the system has about the logged on * user @@ -154,6 +132,9 @@ public class UserConfig { } /** + * Whether the committer name was not explicitly configured but constructed + * from information the system has about the logged on user + * * @return true if the committer name was not explicitly configured but * constructed from information the system has about the logged on * user @@ -163,6 +144,9 @@ public class UserConfig { } /** + * Whether the author email was not explicitly configured but constructed + * from information the system has about the logged on user + * * @return true if the author email was not explicitly configured but * constructed from information the system has about the logged on * user |