Package org.codehaus.plexus.components.io.filemappers

Interface FileMapper

All Known Implementing Classes:

AbstractFileMapper, FileExtensionMapper, FlattenFileMapper, IdentityMapper, MergeFileMapper, PrefixFileMapper, RegExpFileMapper

public interface FileMapper

Interface of a component, which may be used to map file names.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_ROLE_HINT	The default role-hint: "default".
static java.lang.String	ROLE	Role used to register component implementations with the container.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getMappedFileName(java.lang.String pName)	Maps the given source name to a target name.

Field Detail

ROLE

static final java.lang.String ROLE

Role used to register component implementations with the container.

DEFAULT_ROLE_HINT

static final java.lang.String DEFAULT_ROLE_HINT

The default role-hint: "default".

See Also:

Constant Field Values

Method Detail

getMappedFileName

java.lang.String getMappedFileName(java.lang.String pName)

Maps the given source name to a target name.

Parameters:

pName - The source name.

Returns:

The target name.

Throws:

java.lang.IllegalArgumentException - The source name is null or empty.