View Javadoc
1   /*
2    * Copyright (C) 2017, David Pursehouse <david.pursehouse@gmail.com>
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  
44  package org.eclipse.jgit.lib;
45  
46  import org.eclipse.jgit.util.StringUtils;
47  
48  /**
49   * Submodule section of a Git configuration file.
50   *
51   * @since 4.7
52   */
53  public class SubmoduleConfig {
54  
55  	/**
56  	 * Config values for submodule.[name].fetchRecurseSubmodules.
57  	 */
58  	public enum FetchRecurseSubmodulesMode implements Config.ConfigEnum {
59  		/** Unconditionally recurse into all populated submodules. */
60  		YES("true"), //$NON-NLS-1$
61  
62  		/**
63  		 * Only recurse into a populated submodule when the superproject
64  		 * retrieves a commit that updates the submodule's reference to a commit
65  		 * that isn't already in the local submodule clone.
66  		 */
67  		ON_DEMAND("on-demand"), //$NON-NLS-1$
68  
69  		/** Completely disable recursion. */
70  		NO("false"); //$NON-NLS-1$
71  
72  		private final String configValue;
73  
74  		private FetchRecurseSubmodulesMode(String configValue) {
75  			this.configValue = configValue;
76  		}
77  
78  		@Override
79  		public String toConfigValue() {
80  			return configValue;
81  		}
82  
83  		@Override
84  		public boolean matchConfigValue(String s) {
85  			if (StringUtils.isEmptyOrNull(s)) {
86  				return false;
87  			}
88  			s = s.replace('-', '_');
89  			return name().equalsIgnoreCase(s)
90  					|| configValue.equalsIgnoreCase(s);
91  		}
92  	}
93  }