View Javadoc
1   // =================== DO NOT EDIT THIS FILE ====================
2   // Generated by Modello 1.8.2,
3   // any modifications will be overwritten.
4   // ==============================================================
5   
6   package org.apache.maven.scm.providers.cvslib.settings;
7   
8   /**
9    * Class Settings.
10   * 
11   * @version $Revision$ $Date$
12   */
13  @SuppressWarnings( "all" )
14  public class Settings
15      implements java.io.Serializable
16  {
17  
18        //--------------------------/
19       //- Class/Member Variables -/
20      //--------------------------/
21  
22      /**
23       * 
24       *              Date format allowed by changelog command.
25       *           
26       */
27      private String changeLogCommandDateFormat = "yyyy-MM-dd HH:mm:ssZ";
28  
29      /**
30       * 
31       *              Do you want to use .cvsrc file?
32       *           
33       */
34      private boolean useCvsrc = false;
35  
36      /**
37       * 
38       *              Sets the compression level on communications
39       * with the server? If you don't want to use compression, set
40       * it to 0.
41       *           
42       */
43      private int compressionLevel = 3;
44  
45      /**
46       * 
47       *              Traces the execution of a CVS command.
48       *           
49       */
50      private boolean traceCvsCommand = false;
51  
52      /**
53       * 
54       *              Stores any temporary files in DIR instead of
55       * wherever CVS normally puts them (specifically, this
56       * overrides the value of the $TMPDIR environment variable, if
57       * any exists). It should be an absolute path.
58       *           
59       */
60      private String temporaryFilesDirectory;
61  
62      /**
63       * Field cvsVariables.
64       */
65      private java.util.Properties cvsVariables;
66  
67      /**
68       * 
69       *              Move tag if it already exists.
70       *           
71       */
72      private boolean useForceTag = true;
73  
74      /**
75       * Field modelEncoding.
76       */
77      private String modelEncoding = "UTF-8";
78  
79  
80        //-----------/
81       //- Methods -/
82      //-----------/
83  
84      /**
85       * Method addCvsVariable.
86       * 
87       * @param key
88       * @param value
89       */
90      public void addCvsVariable( String key, String value )
91      {
92          getCvsVariables().put( key, value );
93      } //-- void addCvsVariable( String, String )
94  
95      /**
96       * Get date format allowed by changelog command.
97       * 
98       * @return String
99       */
100     public String getChangeLogCommandDateFormat()
101     {
102         return this.changeLogCommandDateFormat;
103     } //-- String getChangeLogCommandDateFormat()
104 
105     /**
106      * Get sets the compression level on communications with the
107      * server? If you don't want to use compression, set it to 0.
108      * 
109      * @return int
110      */
111     public int getCompressionLevel()
112     {
113         return this.compressionLevel;
114     } //-- int getCompressionLevel()
115 
116     /**
117      * Method getCvsVariables.
118      * 
119      * @return Properties
120      */
121     public java.util.Properties getCvsVariables()
122     {
123         if ( this.cvsVariables == null )
124         {
125             this.cvsVariables = new java.util.Properties();
126         }
127 
128         return this.cvsVariables;
129     } //-- java.util.Properties getCvsVariables()
130 
131     /**
132      * Get the modelEncoding field.
133      * 
134      * @return String
135      */
136     public String getModelEncoding()
137     {
138         return this.modelEncoding;
139     } //-- String getModelEncoding()
140 
141     /**
142      * Get stores any temporary files in DIR instead of wherever
143      * CVS normally puts them (specifically, this overrides the
144      * value of the $TMPDIR environment variable, if any exists).
145      * It should be an absolute path.
146      * 
147      * @return String
148      */
149     public String getTemporaryFilesDirectory()
150     {
151         return this.temporaryFilesDirectory;
152     } //-- String getTemporaryFilesDirectory()
153 
154     /**
155      * Get traces the execution of a CVS command.
156      * 
157      * @return boolean
158      */
159     public boolean isTraceCvsCommand()
160     {
161         return this.traceCvsCommand;
162     } //-- boolean isTraceCvsCommand()
163 
164     /**
165      * Get do you want to use .cvsrc file?
166      * 
167      * @return boolean
168      */
169     public boolean isUseCvsrc()
170     {
171         return this.useCvsrc;
172     } //-- boolean isUseCvsrc()
173 
174     /**
175      * Get move tag if it already exists.
176      * 
177      * @return boolean
178      */
179     public boolean isUseForceTag()
180     {
181         return this.useForceTag;
182     } //-- boolean isUseForceTag()
183 
184     /**
185      * Set date format allowed by changelog command.
186      * 
187      * @param changeLogCommandDateFormat
188      */
189     public void setChangeLogCommandDateFormat( String changeLogCommandDateFormat )
190     {
191         this.changeLogCommandDateFormat = changeLogCommandDateFormat;
192     } //-- void setChangeLogCommandDateFormat( String )
193 
194     /**
195      * Set sets the compression level on communications with the
196      * server? If you don't want to use compression, set it to 0.
197      * 
198      * @param compressionLevel
199      */
200     public void setCompressionLevel( int compressionLevel )
201     {
202         this.compressionLevel = compressionLevel;
203     } //-- void setCompressionLevel( int )
204 
205     /**
206      * Set this sets internal CVS variables.
207      * 
208      * @param cvsVariables
209      */
210     public void setCvsVariables( java.util.Properties cvsVariables )
211     {
212         this.cvsVariables = cvsVariables;
213     } //-- void setCvsVariables( java.util.Properties )
214 
215     /**
216      * Set the modelEncoding field.
217      * 
218      * @param modelEncoding
219      */
220     public void setModelEncoding( String modelEncoding )
221     {
222         this.modelEncoding = modelEncoding;
223     } //-- void setModelEncoding( String )
224 
225     /**
226      * Set stores any temporary files in DIR instead of wherever
227      * CVS normally puts them (specifically, this overrides the
228      * value of the $TMPDIR environment variable, if any exists).
229      * It should be an absolute path.
230      * 
231      * @param temporaryFilesDirectory
232      */
233     public void setTemporaryFilesDirectory( String temporaryFilesDirectory )
234     {
235         this.temporaryFilesDirectory = temporaryFilesDirectory;
236     } //-- void setTemporaryFilesDirectory( String )
237 
238     /**
239      * Set traces the execution of a CVS command.
240      * 
241      * @param traceCvsCommand
242      */
243     public void setTraceCvsCommand( boolean traceCvsCommand )
244     {
245         this.traceCvsCommand = traceCvsCommand;
246     } //-- void setTraceCvsCommand( boolean )
247 
248     /**
249      * Set do you want to use .cvsrc file?
250      * 
251      * @param useCvsrc
252      */
253     public void setUseCvsrc( boolean useCvsrc )
254     {
255         this.useCvsrc = useCvsrc;
256     } //-- void setUseCvsrc( boolean )
257 
258     /**
259      * Set move tag if it already exists.
260      * 
261      * @param useForceTag
262      */
263     public void setUseForceTag( boolean useForceTag )
264     {
265         this.useForceTag = useForceTag;
266     } //-- void setUseForceTag( boolean )
267 
268 }