View Javadoc

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