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