001/*
002 =================== DO NOT EDIT THIS FILE ====================
003 Generated by Modello 1.1 on 2014-07-20 16:40:47,
004 any modifications will be overwritten.
005 ==============================================================
006 */
007
008package org.apache.maven.scm.providers.cvslib.settings;
009
010/**
011 * Class Settings.
012 * 
013 * @version $Revision$ $Date$
014 */
015@SuppressWarnings( "all" )
016public class Settings
017    implements java.io.Serializable
018{
019
020      //--------------------------/
021     //- Class/Member Variables -/
022    //--------------------------/
023
024    /**
025     * 
026     *              Date format allowed by changelog command.
027     *           
028     */
029    private String changeLogCommandDateFormat = "yyyy-MM-dd HH:mm:ssZ";
030
031    /**
032     * 
033     *              Do you want to use .cvsrc file?
034     *           
035     */
036    private boolean useCvsrc = false;
037
038    /**
039     * 
040     *              Sets the compression level on communications
041     * with the server? If you don't want to use compression, set
042     * it to 0.
043     *           
044     */
045    private int compressionLevel = 3;
046
047    /**
048     * 
049     *              Traces the execution of a CVS command.
050     *           
051     */
052    private boolean traceCvsCommand = false;
053
054    /**
055     * 
056     *              Stores any temporary files in DIR instead of
057     * wherever CVS normally puts them (specifically, this
058     * overrides the value of the $TMPDIR environment variable, if
059     * any exists). It should be an absolute path.
060     *           
061     */
062    private String temporaryFilesDirectory;
063
064    /**
065     * Field cvsVariables.
066     */
067    private java.util.Properties cvsVariables;
068
069    /**
070     * 
071     *              Move tag if it already exists.
072     *           
073     */
074    private boolean useForceTag = true;
075
076    /**
077     * Field modelEncoding.
078     */
079    private String modelEncoding = "UTF-8";
080
081
082      //-----------/
083     //- Methods -/
084    //-----------/
085
086    /**
087     * Method addCvsVariable.
088     * 
089     * @param key
090     * @param value
091     */
092    public void addCvsVariable( String key, String value )
093    {
094        getCvsVariables().put( key, value );
095    } //-- void addCvsVariable( String, String )
096
097    /**
098     * Get date format allowed by changelog command.
099     * 
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}