View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.scm;
20  
21  import java.io.Serializable;
22  
23  /**
24   * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
25   *
26   */
27  public class CommandParameter implements Serializable {
28      private static final long serialVersionUID = -3391190831054016735L;
29  
30      public static final CommandParameter BINARY = new CommandParameter("binary");
31  
32      public static final CommandParameter RECURSIVE = new CommandParameter("recursive");
33  
34      public static final CommandParameter SHALLOW = new CommandParameter("shallow");
35  
36      public static final CommandParameter MESSAGE = new CommandParameter("message");
37  
38      public static final CommandParameter BRANCH_NAME = new CommandParameter("branchName");
39  
40      public static final CommandParameter START_DATE = new CommandParameter("startDate");
41  
42      public static final CommandParameter END_DATE = new CommandParameter("endDate");
43  
44      public static final CommandParameter NUM_DAYS = new CommandParameter("numDays");
45  
46      public static final CommandParameter LIMIT = new CommandParameter("limit");
47  
48      public static final CommandParameter BRANCH = new CommandParameter("branch");
49  
50      public static final CommandParameter START_SCM_VERSION = new CommandParameter("startScmVersion");
51  
52      public static final CommandParameter END_SCM_VERSION = new CommandParameter("endScmVersion");
53  
54      public static final CommandParameter CHANGELOG_DATE_PATTERN = new CommandParameter("changelogDatePattern");
55  
56      public static final CommandParameter SCM_VERSION = new CommandParameter("scmVersion");
57  
58      public static final CommandParameter TAG_NAME = new CommandParameter("tagName");
59  
60      public static final CommandParameter FILE = new CommandParameter("file");
61  
62      public static final CommandParameter FILES = new CommandParameter("files");
63  
64      public static final CommandParameter OUTPUT_FILE = new CommandParameter("outputFile");
65  
66      public static final CommandParameter OUTPUT_DIRECTORY = new CommandParameter("outputDirectory");
67  
68      public static final CommandParameter RUN_CHANGELOG_WITH_UPDATE = new CommandParameter("run_changelog_with_update");
69  
70      public static final CommandParameter SCM_TAG_PARAMETERS = new CommandParameter("ScmTagParameters");
71  
72      public static final CommandParameter SCM_BRANCH_PARAMETERS = new CommandParameter("ScmBranchParameters");
73  
74      public static final CommandParameter SCM_MKDIR_CREATE_IN_LOCAL = new CommandParameter("createInLocal");
75  
76      /**
77       * Parameter used only for Git SCM to truncate the emitted hash to the given character length, simulates <code>git rev-parse --short=length</code> command.
78       *
79       * @since 1.7
80       */
81      public static final CommandParameter SCM_SHORT_REVISION_LENGTH = new CommandParameter("shortRevisionLength");
82  
83      /**
84       * Parameter to force add
85       *
86       * @since 1.7
87       */
88      public static final CommandParameter FORCE_ADD = new CommandParameter("forceAdd");
89  
90      /**
91       * contains true or false
92       * @since 1.8
93       */
94      public static final CommandParameter IGNORE_WHITESPACE = new CommandParameter("ignoreWhitespace");
95  
96      /**
97       * Parameter name
98       */
99      private String name;
100 
101     /**
102      * @param name The parameter name
103      */
104     private CommandParameter(String name) {
105         this.name = name;
106     }
107 
108     /**
109      * @return The parameter name
110      */
111     public String getName() {
112         return name;
113     }
114 
115     public String toString() {
116         return name;
117     }
118 }