View Javadoc
1   /*
2    Licensed to the Apache Software Foundation (ASF) under one
3    or more contributor license agreements.  See the NOTICE file
4    distributed with this work for additional information
5    regarding copyright ownership.  The ASF licenses this file
6    to you under the Apache License, Version 2.0 (the
7    "License"); you may not use this file except in compliance
8    with the License.  You may obtain a copy of the License at
9    
10       http://www.apache.org/licenses/LICENSE-2.0
11   
12   Unless required by applicable law or agreed to in writing,
13   software distributed under the License is distributed on an
14   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   KIND, either express or implied.  See the License for the
16   specific language governing permissions and limitations
17   under the License.
18   =================== DO NOT EDIT THIS FILE ====================
19   Generated by Modello 2.4.0,
20   any modifications will be overwritten.
21   ==============================================================
22   */
23  
24  package org.apache.maven.archetype.model;
25  
26  /**
27   * Describes a resource file.
28   * 
29   * @version $Revision$ $Date$
30   */
31  @SuppressWarnings( "all" )
32  public class Resource
33      implements java.io.Serializable
34  {
35  
36        //--------------------------/
37       //- Class/Member Variables -/
38      //--------------------------/
39  
40      /**
41       * The resource file.
42       */
43      private String file;
44  
45      /**
46       * The encoding to be used when reading/writing this file.
47       *             Platform encoding is used by default, or
48       * ISO-8859-1 when filename ends in <code>.properties</code>
49       */
50      private String encoding;
51  
52      /**
53       * A resource can be filtered, which means the file will be
54       * used as Velocity template.
55       *           It can be non-filtered, which means the file will
56       * be copied without modification.
57       */
58      private boolean filtered = true;
59  
60  
61        //-----------/
62       //- Methods -/
63      //-----------/
64  
65      /**
66       * Get the encoding to be used when reading/writing this file.
67       *             Platform encoding is used by default, or
68       * ISO-8859-1 when filename ends in <code>.properties</code>
69       * 
70       * @return String
71       */
72      public String getEncoding()
73      {
74          return this.encoding;
75      } //-- String getEncoding()
76  
77      /**
78       * Get the resource file.
79       * 
80       * @return String
81       */
82      public String getFile()
83      {
84          return this.file;
85      } //-- String getFile()
86  
87      /**
88       * Get a resource can be filtered, which means the file will be
89       * used as Velocity template.
90       *           It can be non-filtered, which means the file will
91       * be copied without modification.
92       * 
93       * @return boolean
94       */
95      public boolean isFiltered()
96      {
97          return this.filtered;
98      } //-- boolean isFiltered()
99  
100     /**
101      * Set the encoding to be used when reading/writing this file.
102      *             Platform encoding is used by default, or
103      * ISO-8859-1 when filename ends in <code>.properties</code>
104      * 
105      * @param encoding a encoding object.
106      */
107     public void setEncoding( String encoding )
108     {
109         this.encoding = encoding;
110     } //-- void setEncoding( String )
111 
112     /**
113      * Set the resource file.
114      * 
115      * @param file a file object.
116      */
117     public void setFile( String file )
118     {
119         this.file = file;
120     } //-- void setFile( String )
121 
122     /**
123      * Set a resource can be filtered, which means the file will be
124      * used as Velocity template.
125      *           It can be non-filtered, which means the file will
126      * be copied without modification.
127      * 
128      * @param filtered a filtered object.
129      */
130     public void setFiltered( boolean filtered )
131     {
132         this.filtered = filtered;
133     } //-- void setFiltered( boolean )
134 
135 }