Coverage Report

Coverage Report - org.apache.maven.scm.provider.jazz.command.JazzConstants

Classes in this File

Line Coverage

Branch Coverage

Complexity

JazzConstants

0 %

0/1

N/A

 package org.apache.maven.scm.provider.jazz.command;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  * http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 
 /**
  * @author <a href="mailto:ChrisGWarp@gmail.com">Chris Graham</a>
  */
 public class JazzConstants
 {
     // -------------------------------------------------------------------------------------------------
     // MISC.
     // -------------------------------------------------------------------------------------------------
 
     /**
      * Executable for Jazz SCM (Rational Team Concert).
      */
     public static final String SCM_EXECUTABLE = "scm";
 
     /**
      * Folder created by the SCM to store metadata.
      */
     public static final String SCM_META_DATA_FOLDER = ".jazz5";
 
     /**
      * SCM type identifier
      */
     public static final String SCM_TYPE = "jazz";
 
     // -------------------------------------------------------------------------------------------------
     // COMMANDS
     // -------------------------------------------------------------------------------------------------
 
     /**
      * Accept command - Accept change sets into a repository workspace and load them into the local workspace.
      */
     public static final String CMD_ACCEPT = "accept";
 
     /**
      * Annotate command - Show line-by-line revision information for a file.
      */
     public static final String CMD_ANNOTATE = "annotate";
 
     /**
      * Checkin command - Check in locally modified files, adding them to the current change set.
      */
     public static final String CMD_CHECKIN = "checkin";
 
     /**
      * Create command - Can be used with a sub command to create a snapshot (tag) or repository workspace (branch).
      */
     public static final String CMD_CREATE = "create";
 
     /**
      * Deliver command - Deliver to a target.
      */
     public static final String CMD_DELIVER = "deliver";
 
     /**
      * Diff command - Compare two states of a file.
      */
     public static final String CMD_DIFF = "diff";
 
     /**
      * History command - Show the history of a file or component.
      */
     public static final String CMD_HISTORY = "history";
 
     /**
      * List command - List repository objects.
      */
     public static final String CMD_LIST = "list";
 
     /**
      * Load command - Load components from a repository workspace into a local workspace.
      */
     public static final String CMD_LOAD = "load";
 
     /**
      * Lock command - Used to lock or revoke locks on files in a stream. (requires 'acquire' or 'release' sub commands).
      */
     public static final String CMD_LOCK = "lock";
 
     /**
      * Snapshot command - Used to promote snapshots. Requires the 'promote' sub command.
      */
     public static final String CMD_SNAPSHOT = "snapshot";
 
     /**
      * Status command - Show modification status of items in a workspace.
      */
     public static final String CMD_STATUS = "status";
 
     // -------------------------------------------------------------------------------------------------
     // SUB-COMMANDS
     // -------------------------------------------------------------------------------------------------
 
     // CREATE sub commands
 
     /**
      * The 'type' (snapshot) of the create command.
      */
     public static final String CMD_SUB_SNAPSHOT = "snapshot";
 
     /**
      * The 'type' (workspace) of the create command.
      */
     public static final String CMD_SUB_WORKSPACE = "workspace";
 
     /**
      * The 'type' (changeset) of the create command.
      */
     public static final String CMD_SUB_CHANGESET = "changeset";
 
     // LIST sub commands
 
     /**
      * List files in a remote workspace.
      */
     public static final String CMD_SUB_REMOTEFILES = "remotefiles";
 
     /**
      * List files in a remote workspace.
      */
     public static final String CMD_SUB_CHANGESETS = "changesets";
 
     // LOCK sub commands
 
     /**
      * Locks files in a stream.
      */
     public static final String CMD_SUB_ACQUIRE = "acquire";
 
     /**
      * Revoke locks on files in a stream.
      */
     public static final String CMD_SUB_RELEASE = "release";
 
     // SNAPSHOT sub commands
 
     /**
      * Promotes a snapshot to a stream or workspace.
      */
     public static final String CMD_SUB_PROMOTE = "promote";
 
     // -------------------------------------------------------------------------------------------------
     // ARGUMENTS
     // -------------------------------------------------------------------------------------------------
 
     /**
      * Accept component additions and deletions (used with "accept" command).
      */
     public static final String ARG_FLOW_COMPONENTS = "--flow-components";
 
     /**
      * Overwrite existing files when loading (used with "load" command).
      */
     public static final String ARG_FORCE = "--force";
 
     /**
      * Local workspace path.
      */
     public static final String ARG_LOCAL_WORKSPACE_PATH = "--dir";
 
     /**
      * Load Root Directory.
      */
     public static final String ARG_LOAD_ROOT_DIRECTORY = "--directory";
 
     /**
      * The repository name.
      */
     public static final String ARG_REPOSITORY_URI = "--repository-uri";
 
     /**
      * Description for the snapshot (used with "create snapshot" command).
      */
     public static final String ARG_SNAPSHOT_DESCRIPTION = "--description";
 
     /**
      * Name of the snapshot (used with "create snapshot" command).
      */
     public static final String ARG_SNAPSHOT_NAME = "--name";
 
     /**
      * Forces the output to not shorten, otherwise the width will be based on the COLUMNS environment variable, or if
      * that is not set, to 80 characters. (used with the "status" command).
      */
     public static final String ARG_STATUS_WIDE_PRINT_OUT = "--wide";
 
     /**
      * The user ID in the repository.
      */
     public static final String ARG_USER_NAME = "--username";
 
     /**
      * The user password in the repository.
      */
     public static final String ARG_USER_PASSWORD = "--password";
 
     /**
      * Description for the repository workspace (used with "create workspace" command).
      */
     public static final String ARG_WORKSPACE_DESCRIPTION = "--description";
 
     /**
      * Name of the repository workspace (used with "create workspace" command).
      */
     public static final String ARG_WORKSPACE_NAME = "--name";
 
     /**
      * Name of the repository workspace (used with "create workspace" command).
      */
     public static final String ARG_WORKSPACE_SNAPSHOT = "--snapshot";
 
     /**
      * Name of the source repository workspace (used with "deliver" command).
      */
     public static final String ARG_DELIVER_SOURCE = "--source";
 
     /**
      * Name of the target repository workspace or stream (used with "deliver" command).
      */
     public static final String ARG_DELIVER_TARGET = "--target";
 
     /**
      * Ignore uncommitted changes and deliver (used with "deliver" command).
      */
     public static final String ARG_OVERWRITE_UNCOMMITTED = "--overwrite-uncommitted";
 
     /**
      * Perform a file base diff (aftertype = file) (used with "diff" command).
      */
     public static final String ARG_FILE = "file";
 
     /**
      * Specify the maximum number of results to return, must be greater than zero.
      * Used by numerous commands.
      */
     public static final String ARG_MAXIMUM = "--maximum";
 
     /**
      * Name of the repository workspace (used with "list changesets" command).
      */
     public static final String ARG_WORKSPACE = "--workspace";
 
 }

1		package org.apache.maven.scm.provider.jazz.command;
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		/**
23		* @author <a href="mailto:ChrisGWarp@gmail.com">Chris Graham</a>
24		*/
25	0	public class JazzConstants
26		{
27		// -------------------------------------------------------------------------------------------------
28		// MISC.
29		// -------------------------------------------------------------------------------------------------
30
31		/**
32		* Executable for Jazz SCM (Rational Team Concert).
33		*/
34		public static final String SCM_EXECUTABLE = "scm";
35
36		/**
37		* Folder created by the SCM to store metadata.
38		*/
39		public static final String SCM_META_DATA_FOLDER = ".jazz5";
40
41		/**
42		* SCM type identifier
43		*/
44		public static final String SCM_TYPE = "jazz";
45
46		// -------------------------------------------------------------------------------------------------
47		// COMMANDS
48		// -------------------------------------------------------------------------------------------------
49
50		/**
51		* Accept command - Accept change sets into a repository workspace and load them into the local workspace.
52		*/
53		public static final String CMD_ACCEPT = "accept";
54
55		/**
56		* Annotate command - Show line-by-line revision information for a file.
57		*/
58		public static final String CMD_ANNOTATE = "annotate";
59
60		/**
61		* Checkin command - Check in locally modified files, adding them to the current change set.
62		*/
63		public static final String CMD_CHECKIN = "checkin";
64
65		/**
66		* Create command - Can be used with a sub command to create a snapshot (tag) or repository workspace (branch).
67		*/
68		public static final String CMD_CREATE = "create";
69
70		/**
71		* Deliver command - Deliver to a target.
72		*/
73		public static final String CMD_DELIVER = "deliver";
74
75		/**
76		* Diff command - Compare two states of a file.
77		*/
78		public static final String CMD_DIFF = "diff";
79
80		/**
81		* History command - Show the history of a file or component.
82		*/
83		public static final String CMD_HISTORY = "history";
84
85		/**
86		* List command - List repository objects.
87		*/
88		public static final String CMD_LIST = "list";
89
90		/**
91		* Load command - Load components from a repository workspace into a local workspace.
92		*/
93		public static final String CMD_LOAD = "load";
94
95		/**
96		* Lock command - Used to lock or revoke locks on files in a stream. (requires 'acquire' or 'release' sub commands).
97		*/
98		public static final String CMD_LOCK = "lock";
99
100		/**
101		* Snapshot command - Used to promote snapshots. Requires the 'promote' sub command.
102		*/
103		public static final String CMD_SNAPSHOT = "snapshot";
104
105		/**
106		* Status command - Show modification status of items in a workspace.
107		*/
108		public static final String CMD_STATUS = "status";
109
110		// -------------------------------------------------------------------------------------------------
111		// SUB-COMMANDS
112		// -------------------------------------------------------------------------------------------------
113
114		// CREATE sub commands
115
116		/**
117		* The 'type' (snapshot) of the create command.
118		*/
119		public static final String CMD_SUB_SNAPSHOT = "snapshot";
120
121		/**
122		* The 'type' (workspace) of the create command.
123		*/
124		public static final String CMD_SUB_WORKSPACE = "workspace";
125
126		/**
127		* The 'type' (changeset) of the create command.
128		*/
129		public static final String CMD_SUB_CHANGESET = "changeset";
130
131		// LIST sub commands
132
133		/**
134		* List files in a remote workspace.
135		*/
136		public static final String CMD_SUB_REMOTEFILES = "remotefiles";
137
138		/**
139		* List files in a remote workspace.
140		*/
141		public static final String CMD_SUB_CHANGESETS = "changesets";
142
143		// LOCK sub commands
144
145		/**
146		* Locks files in a stream.
147		*/
148		public static final String CMD_SUB_ACQUIRE = "acquire";
149
150		/**
151		* Revoke locks on files in a stream.
152		*/
153		public static final String CMD_SUB_RELEASE = "release";
154
155		// SNAPSHOT sub commands
156
157		/**
158		* Promotes a snapshot to a stream or workspace.
159		*/
160		public static final String CMD_SUB_PROMOTE = "promote";
161
162		// -------------------------------------------------------------------------------------------------
163		// ARGUMENTS
164		// -------------------------------------------------------------------------------------------------
165
166		/**
167		* Accept component additions and deletions (used with "accept" command).
168		*/
169		public static final String ARG_FLOW_COMPONENTS = "--flow-components";
170
171		/**
172		* Overwrite existing files when loading (used with "load" command).
173		*/
174		public static final String ARG_FORCE = "--force";
175
176		/**
177		* Local workspace path.
178		*/
179		public static final String ARG_LOCAL_WORKSPACE_PATH = "--dir";
180
181		/**
182		* Load Root Directory.
183		*/
184		public static final String ARG_LOAD_ROOT_DIRECTORY = "--directory";
185
186		/**
187		* The repository name.
188		*/
189		public static final String ARG_REPOSITORY_URI = "--repository-uri";
190
191		/**
192		* Description for the snapshot (used with "create snapshot" command).
193		*/
194		public static final String ARG_SNAPSHOT_DESCRIPTION = "--description";
195
196		/**
197		* Name of the snapshot (used with "create snapshot" command).
198		*/
199		public static final String ARG_SNAPSHOT_NAME = "--name";
200
201		/**
202		* Forces the output to not shorten, otherwise the width will be based on the COLUMNS environment variable, or if
203		* that is not set, to 80 characters. (used with the "status" command).
204		*/
205		public static final String ARG_STATUS_WIDE_PRINT_OUT = "--wide";
206
207		/**
208		* The user ID in the repository.
209		*/
210		public static final String ARG_USER_NAME = "--username";
211
212		/**
213		* The user password in the repository.
214		*/
215		public static final String ARG_USER_PASSWORD = "--password";
216
217		/**
218		* Description for the repository workspace (used with "create workspace" command).
219		*/
220		public static final String ARG_WORKSPACE_DESCRIPTION = "--description";
221
222		/**
223		* Name of the repository workspace (used with "create workspace" command).
224		*/
225		public static final String ARG_WORKSPACE_NAME = "--name";
226
227		/**
228		* Name of the repository workspace (used with "create workspace" command).
229		*/
230		public static final String ARG_WORKSPACE_SNAPSHOT = "--snapshot";
231
232		/**
233		* Name of the source repository workspace (used with "deliver" command).
234		*/
235		public static final String ARG_DELIVER_SOURCE = "--source";
236
237		/**
238		* Name of the target repository workspace or stream (used with "deliver" command).
239		*/
240		public static final String ARG_DELIVER_TARGET = "--target";
241
242		/**
243		* Ignore uncommitted changes and deliver (used with "deliver" command).
244		*/
245		public static final String ARG_OVERWRITE_UNCOMMITTED = "--overwrite-uncommitted";
246
247		/**
248		* Perform a file base diff (aftertype = file) (used with "diff" command).
249		*/
250		public static final String ARG_FILE = "file";
251
252		/**
253		* Specify the maximum number of results to return, must be greater than zero.
254		* Used by numerous commands.
255		*/
256		public static final String ARG_MAXIMUM = "--maximum";
257
258		/**
259		* Name of the repository workspace (used with "list changesets" command).
260		*/
261		public static final String ARG_WORKSPACE = "--workspace";
262
263		}