View Javadoc

1   /*
2    =================== DO NOT EDIT THIS FILE ====================
3    Generated by Modello 1.4.1 on 2011-11-23 07:30:23,
4    any modifications will be overwritten.
5    ==============================================================
6    */
7   
8   package org.apache.maven.archetype.model;
9   
10  /**
11   * Describes a resource file.
12   * 
13   * @version $Revision$ $Date$
14   */
15  @SuppressWarnings( "all" )
16  public class Resource
17      implements java.io.Serializable
18  {
19  
20        //--------------------------/
21       //- Class/Member Variables -/
22      //--------------------------/
23  
24      /**
25       * The resource file.
26       */
27      private String file;
28  
29      /**
30       * The encoding to be used when reading/writing this file.
31       *             Platform encoding is used by default, or
32       * ISO-8859-1 when filename ends in <code>.properties</code>
33       */
34      private String encoding;
35  
36      /**
37       * A resource can be filtered, which means the file will be
38       * used as Velocity template.
39       *           It can be non-filtered, which means the file will
40       * be copied without modification.
41       */
42      private boolean filtered = true;
43  
44  
45        //-----------/
46       //- Methods -/
47      //-----------/
48  
49      /**
50       * Get the encoding to be used when reading/writing this file.
51       *             Platform encoding is used by default, or
52       * ISO-8859-1 when filename ends in <code>.properties</code>
53       * 
54       * @return String
55       */
56      public String getEncoding()
57      {
58          return this.encoding;
59      } //-- String getEncoding()
60  
61      /**
62       * Get the resource file.
63       * 
64       * @return String
65       */
66      public String getFile()
67      {
68          return this.file;
69      } //-- String getFile()
70  
71      /**
72       * Get a resource can be filtered, which means the file will be
73       * used as Velocity template.
74       *           It can be non-filtered, which means the file will
75       * be copied without modification.
76       * 
77       * @return boolean
78       */
79      public boolean isFiltered()
80      {
81          return this.filtered;
82      } //-- boolean isFiltered()
83  
84      /**
85       * Set the encoding to be used when reading/writing this file.
86       *             Platform encoding is used by default, or
87       * ISO-8859-1 when filename ends in <code>.properties</code>
88       * 
89       * @param encoding
90       */
91      public void setEncoding( String encoding )
92      {
93          this.encoding = encoding;
94      } //-- void setEncoding( String )
95  
96      /**
97       * Set the resource file.
98       * 
99       * @param file
100      */
101     public void setFile( String file )
102     {
103         this.file = file;
104     } //-- void setFile( String )
105 
106     /**
107      * Set a resource can be filtered, which means the file will be
108      * used as Velocity template.
109      *           It can be non-filtered, which means the file will
110      * be copied without modification.
111      * 
112      * @param filtered
113      */
114     public void setFiltered( boolean filtered )
115     {
116         this.filtered = filtered;
117     } //-- void setFiltered( boolean )
118 
119 }