Package org.apache.maven.shared.model.fileset.mappers

Class FlatFileNameMapper

java.lang.Object

org.apache.maven.shared.model.fileset.mappers.FlatFileNameMapper

All Implemented Interfaces:

FileNameMapper

public class FlatFileNameMapper
extends Object
implements FileNameMapper

Implementation of FileNameMapper that always returns the source file name without any leading directory information.

This is the default FileNameMapper for the copy and move tasks if the flatten attribute has been set.

Constructor Summary

Constructors

Constructor	Description
FlatFileNameMapper()

Method Summary

Modifier and Type	Method	Description
String	mapFileName(String sourceFileName)	Returns the target filename for the given source file.
void	setFrom(String from)	Sets the from part of the transformation rule.
void	setTo(String to)	Sets the to part of the transformation rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FlatFileNameMapper

public FlatFileNameMapper()

Method Details

setFrom

public void setFrom(String from)

Description copied from interface: FileNameMapper

Sets the from part of the transformation rule.

Specified by:

setFrom in interface FileNameMapper

Parameters:

from - the source

setTo

public void setTo(String to)

Description copied from interface: FileNameMapper

Sets the to part of the transformation rule.

Specified by:

setTo in interface FileNameMapper

Parameters:

to - the destination

mapFileName

public String mapFileName(String sourceFileName)

Description copied from interface: FileNameMapper

Returns the target filename for the given source file.

If the given rule doesn't apply to the source file, the implementation must return null. SourceFileScanner will then omit the source file in question.

Specified by:

mapFileName in interface FileNameMapper

Parameters:

sourceFileName - the name of the source file relative to some given base directory

Returns:

the target filename for the given source file