org.apache.maven.shared.model.fileset
Class Mapper
java.lang.Object
org.apache.maven.shared.model.fileset.Mapper
- All Implemented Interfaces:
- java.io.Serializable
public class Mapper
- extends java.lang.Object
- implements java.io.Serializable
Class Mapper.
- Version:
- $Revision: 886882 $ $Date: 2013-11-16 21:55:43 +0000 (Sat, 16 Nov 2013) $
- See Also:
- Serialized Form
Method Summary |
java.lang.String |
getClassname()
Get
Allows specification of a custom mapper
implementation. |
java.lang.String |
getFrom()
Get
Specifies a type-specific pattern for matching
source paths which should be mapped. |
java.lang.String |
getModelEncoding()
|
java.lang.String |
getTo()
Get
Specifies a type-specific pattern for producing
paths based on source paths. |
java.lang.String |
getType()
Get
Specifies a built-in mapper implementation. |
void |
setClassname(java.lang.String classname)
Set
Allows specification of a custom mapper
implementation. |
void |
setFrom(java.lang.String from)
Set
Specifies a type-specific pattern for matching
source paths which should be mapped. |
void |
setModelEncoding(java.lang.String modelEncoding)
Set an encoding used for reading/writing the model. |
void |
setTo(java.lang.String to)
Set
Specifies a type-specific pattern for producing
paths based on source paths. |
void |
setType(java.lang.String type)
Set
Specifies a built-in mapper implementation. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Mapper
public Mapper()
getClassname
public java.lang.String getClassname()
- Get
Allows specification of a custom mapper
implementation. The class must be of type
org.apache.maven.shared.model.fileset.mappers.FileNameMapper,
from the artifact
org.apache.maven.shared:file-management.
- Returns:
- String
getFrom
public java.lang.String getFrom()
- Get
Specifies a type-specific pattern for matching
source paths which should be mapped.
- Returns:
- String
getTo
public java.lang.String getTo()
- Get
Specifies a type-specific pattern for producing
paths based on source paths.
- Returns:
- String
getType
public java.lang.String getType()
- Get
Specifies a built-in mapper implementation.
Valid values:
- "flatten" -
The target file name is identical to the
source file name, with all leading
directory information stripped off. Both
to and from will be ignored.
- "glob" -
Both to and from define patterns that may
contain at most one *. For each source
file that matches the from pattern, a
target file name will be constructed from
the to pattern by substituting the * in
the to pattern with the text that matches
the * in the from pattern. Source file
names that don't match the from pattern
will be ignored.
- "regexp" -
Both to and from define regular
expressions. If the source file name matches the
from pattern, the target file name will be
constructed from the to pattern, using
\0 to \9 as back-references for the full
match (\0) or the matches of the
subexpressions in parentheses. Source
files not matching the from pattern will be
ignored.
- "merge" -
The target file name will always be the
same, as defined by to. from will be
ignored.
- "package" -
Sharing the same syntax as the glob
mapper, the package mapper replaces directory
separators found in the matched source
pattern with dots in the target pattern
placeholder.
- "unpackage" -
This mapper is the inverse of the package
mapper. It replaces the dots in a
package name with directory separators.
This is useful for matching XML formatter
results against their JUnit test test
cases. The mapper shares the sample syntax
as the glob mapper.
- Returns:
- String
setClassname
public void setClassname(java.lang.String classname)
- Set
Allows specification of a custom mapper
implementation. The class must be of type
org.apache.maven.shared.model.fileset.mappers.FileNameMapper,
from the artifact
org.apache.maven.shared:file-management.
- Parameters:
classname
-
setFrom
public void setFrom(java.lang.String from)
- Set
Specifies a type-specific pattern for matching
source paths which should be mapped.
- Parameters:
from
-
setTo
public void setTo(java.lang.String to)
- Set
Specifies a type-specific pattern for producing
paths based on source paths.
- Parameters:
to
-
setType
public void setType(java.lang.String type)
- Set
Specifies a built-in mapper implementation.
Valid values:
- "flatten" -
The target file name is identical to the
source file name, with all leading
directory information stripped off. Both
to and from will be ignored.
- "glob" -
Both to and from define patterns that may
contain at most one *. For each source
file that matches the from pattern, a
target file name will be constructed from
the to pattern by substituting the * in
the to pattern with the text that matches
the * in the from pattern. Source file
names that don't match the from pattern
will be ignored.
- "regexp" -
Both to and from define regular
expressions. If the source file name matches the
from pattern, the target file name will be
constructed from the to pattern, using
\0 to \9 as back-references for the full
match (\0) or the matches of the
subexpressions in parentheses. Source
files not matching the from pattern will be
ignored.
- "merge" -
The target file name will always be the
same, as defined by to. from will be
ignored.
- "package" -
Sharing the same syntax as the glob
mapper, the package mapper replaces directory
separators found in the matched source
pattern with dots in the target pattern
placeholder.
- "unpackage" -
This mapper is the inverse of the package
mapper. It replaces the dots in a
package name with directory separators.
This is useful for matching XML formatter
results against their JUnit test test
cases. The mapper shares the sample syntax
as the glob mapper.
- Parameters:
type
-
setModelEncoding
public void setModelEncoding(java.lang.String modelEncoding)
- Set an encoding used for reading/writing the model.
- Parameters:
modelEncoding
- the encoding used when reading/writing the model.
getModelEncoding
public java.lang.String getModelEncoding()
- Returns:
- the current encoding used when reading/writing this model.
Copyright © 2002-2009 The Apache Software Foundation. All Rights Reserved.