1 // =================== DO NOT EDIT THIS FILE ==================== 2 // Generated by Modello 2.0.0, 3 // any modifications will be overwritten. 4 // ============================================================== 5 6 package org.apache.maven.shared.model.fileset; 7 8 /** 9 * Class Mapper. 10 * 11 * @version $Revision$ $Date$ 12 */ 13 @SuppressWarnings( "all" ) 14 public class Mapper 15 implements java.io.Serializable 16 { 17 18 //--------------------------/ 19 //- Class/Member Variables -/ 20 //--------------------------/ 21 22 /** 23 * 24 * 25 * Specifies a built-in mapper implementation. 26 * <br/> 27 * Valid values: 28 * <ul> 29 * <li><b>"flatten"</b> - 30 * The target file name is identical to the 31 * source file name, with all leading 32 * directory information stripped off. Both 33 * to and from will be ignored. 34 * </li> 35 * <li><b>"glob"</b> - 36 * Both to and from define patterns that may 37 * contain at most one *. For each source 38 * file that matches the from pattern, a 39 * target file name will be constructed from 40 * the to pattern by substituting the * in 41 * the to pattern with the text that matches 42 * the * in the from pattern. Source file 43 * names that don't match the from pattern 44 * will be ignored. 45 * </li> 46 * <li><b>"regexp"</b> - 47 * Both to and from define regular 48 * expressions. If the source file name matches the 49 * from pattern, the target file name will be 50 * constructed from the to pattern, using 51 * \0 to \9 as back-references for the full 52 * match (\0) or the matches of the 53 * subexpressions in parentheses. Source 54 * files not matching the from pattern will be 55 * ignored. 56 * </li> 57 * <li><b>"merge"</b> - 58 * The target file name will always be the 59 * same, as defined by to. from will be 60 * ignored. 61 * </li> 62 * <li><b>"package"</b> - 63 * Sharing the same syntax as the glob 64 * mapper, the package mapper replaces directory 65 * separators found in the matched source 66 * pattern with dots in the target pattern 67 * placeholder. 68 * </li> 69 * <li><b>"unpackage"</b> - 70 * This mapper is the inverse of the package 71 * mapper. It replaces the dots in a 72 * package name with directory separators. 73 * This is useful for matching XML formatter 74 * results against their JUnit test test 75 * cases. The mapper shares the sample syntax 76 * as the glob mapper. 77 * </li> 78 * </ul> 79 * 80 * 81 */ 82 private String type = "identity"; 83 84 /** 85 * 86 * Specifies a type-specific pattern for matching 87 * source paths which should be mapped. 88 * 89 */ 90 private String from; 91 92 /** 93 * 94 * Specifies a type-specific pattern for producing 95 * paths based on source paths. 96 * 97 */ 98 private String to; 99 100 /** 101 * 102 * Allows specification of a custom mapper 103 * implementation. The class must be of type 104 * 105 * org.apache.maven.shared.model.fileset.mappers.FileNameMapper, 106 * from the artifact 107 * org.apache.maven.shared:file-management. 108 * 109 */ 110 private String classname; 111 112 113 //-----------/ 114 //- Methods -/ 115 //-----------/ 116 117 /** 118 * Get allows specification of a custom mapper implementation. 119 * The class must be of type 120 * 121 * org.apache.maven.shared.model.fileset.mappers.FileNameMapper, 122 * from the artifact 123 * org.apache.maven.shared:file-management. 124 * 125 * @return String 126 */ 127 public String getClassname() 128 { 129 return this.classname; 130 } //-- String getClassname() 131 132 /** 133 * Get specifies a type-specific pattern for matching source 134 * paths which should be mapped. 135 * 136 * @return String 137 */ 138 public String getFrom() 139 { 140 return this.from; 141 } //-- String getFrom() 142 143 /** 144 * Get specifies a type-specific pattern for producing paths 145 * based on source paths. 146 * 147 * @return String 148 */ 149 public String getTo() 150 { 151 return this.to; 152 } //-- String getTo() 153 154 /** 155 * Get specifies a built-in mapper implementation. 156 * <br/> 157 * Valid values: 158 * <ul> 159 * <li><b>"flatten"</b> - 160 * The target file name is identical to the 161 * source file name, with all leading 162 * directory information stripped off. Both 163 * to and from will be ignored. 164 * </li> 165 * <li><b>"glob"</b> - 166 * Both to and from define patterns that may 167 * contain at most one *. For each source 168 * file that matches the from pattern, a 169 * target file name will be constructed from 170 * the to pattern by substituting the * in 171 * the to pattern with the text that matches 172 * the * in the from pattern. Source file 173 * names that don't match the from pattern 174 * will be ignored. 175 * </li> 176 * <li><b>"regexp"</b> - 177 * Both to and from define regular 178 * expressions. If the source file name matches the 179 * from pattern, the target file name will be 180 * constructed from the to pattern, using 181 * \0 to \9 as back-references for the full 182 * match (\0) or the matches of the 183 * subexpressions in parentheses. Source 184 * files not matching the from pattern will be 185 * ignored. 186 * </li> 187 * <li><b>"merge"</b> - 188 * The target file name will always be the 189 * same, as defined by to. from will be 190 * ignored. 191 * </li> 192 * <li><b>"package"</b> - 193 * Sharing the same syntax as the glob 194 * mapper, the package mapper replaces directory 195 * separators found in the matched source 196 * pattern with dots in the target pattern 197 * placeholder. 198 * </li> 199 * <li><b>"unpackage"</b> - 200 * This mapper is the inverse of the package 201 * mapper. It replaces the dots in a 202 * package name with directory separators. 203 * This is useful for matching XML formatter 204 * results against their JUnit test test 205 * cases. The mapper shares the sample syntax 206 * as the glob mapper. 207 * </li> 208 * </ul> 209 * 210 * @return String 211 */ 212 public String getType() 213 { 214 return this.type; 215 } //-- String getType() 216 217 /** 218 * Set allows specification of a custom mapper implementation. 219 * The class must be of type 220 * 221 * org.apache.maven.shared.model.fileset.mappers.FileNameMapper, 222 * from the artifact 223 * org.apache.maven.shared:file-management. 224 * 225 * @param classname a classname object. 226 */ 227 public void setClassname( String classname ) 228 { 229 this.classname = classname; 230 } //-- void setClassname( String ) 231 232 /** 233 * Set specifies a type-specific pattern for matching source 234 * paths which should be mapped. 235 * 236 * @param from a from object. 237 */ 238 public void setFrom( String from ) 239 { 240 this.from = from; 241 } //-- void setFrom( String ) 242 243 /** 244 * Set specifies a type-specific pattern for producing paths 245 * based on source paths. 246 * 247 * @param to a to object. 248 */ 249 public void setTo( String to ) 250 { 251 this.to = to; 252 } //-- void setTo( String ) 253 254 /** 255 * Set specifies a built-in mapper implementation. 256 * <br/> 257 * Valid values: 258 * <ul> 259 * <li><b>"flatten"</b> - 260 * The target file name is identical to the 261 * source file name, with all leading 262 * directory information stripped off. Both 263 * to and from will be ignored. 264 * </li> 265 * <li><b>"glob"</b> - 266 * Both to and from define patterns that may 267 * contain at most one *. For each source 268 * file that matches the from pattern, a 269 * target file name will be constructed from 270 * the to pattern by substituting the * in 271 * the to pattern with the text that matches 272 * the * in the from pattern. Source file 273 * names that don't match the from pattern 274 * will be ignored. 275 * </li> 276 * <li><b>"regexp"</b> - 277 * Both to and from define regular 278 * expressions. If the source file name matches the 279 * from pattern, the target file name will be 280 * constructed from the to pattern, using 281 * \0 to \9 as back-references for the full 282 * match (\0) or the matches of the 283 * subexpressions in parentheses. Source 284 * files not matching the from pattern will be 285 * ignored. 286 * </li> 287 * <li><b>"merge"</b> - 288 * The target file name will always be the 289 * same, as defined by to. from will be 290 * ignored. 291 * </li> 292 * <li><b>"package"</b> - 293 * Sharing the same syntax as the glob 294 * mapper, the package mapper replaces directory 295 * separators found in the matched source 296 * pattern with dots in the target pattern 297 * placeholder. 298 * </li> 299 * <li><b>"unpackage"</b> - 300 * This mapper is the inverse of the package 301 * mapper. It replaces the dots in a 302 * package name with directory separators. 303 * This is useful for matching XML formatter 304 * results against their JUnit test test 305 * cases. The mapper shares the sample syntax 306 * as the glob mapper. 307 * </li> 308 * </ul> 309 * 310 * @param type a type object. 311 */ 312 public void setType( String type ) 313 { 314 this.type = type; 315 } //-- void setType( String ) 316 317 }