org.codehaus.plexus.components.io.filemappers

Class PrefixFileMapper

java.lang.Object

org.codehaus.plexus.components.io.filemappers.AbstractFileMapper

org.codehaus.plexus.components.io.filemappers.PrefixFileMapper

All Implemented Interfaces:

FileMapper

public class PrefixFileMapper
extends AbstractFileMapper

A file mapper, which maps by adding a prefix.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	prefix
static java.lang.String	ROLE_HINT The merge mappers role-hint: "prefix".

Fields inherited from interface org.codehaus.plexus.components.io.filemappers.FileMapper

DEFAULT_ROLE_HINT, ROLE

Constructor Summary

Constructors

Constructor and Description
PrefixFileMapper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMappedFileName(java.lang.String name) Checks the input and returns it without modifications.
static java.lang.String	getMappedFileName(java.lang.String prefix, java.lang.String name) Performs the mapping of a file name by adding a prefix.
java.lang.String	getPrefix() Returns the prefix to add.
void	setPrefix(java.lang.String prefix) Sets the prefix to add.

Methods inherited from class java.lang.Object

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

Field Detail

ROLE_HINT

public static final java.lang.String ROLE_HINT

The merge mappers role-hint: "prefix".

See Also:

Constant Field Values

prefix

private java.lang.String prefix

Constructor Detail

PrefixFileMapper

public PrefixFileMapper()

Method Detail

getMappedFileName

@Nonnull
public java.lang.String getMappedFileName(@Nonnull
                                                   java.lang.String name)

Description copied from class: AbstractFileMapper

Checks the input and returns it without modifications.

Specified by:

getMappedFileName in interface FileMapper

Overrides:

getMappedFileName in class AbstractFileMapper

Parameters:

name - The source name.

Returns:

The target name.

getPrefix

public java.lang.String getPrefix()

Returns the prefix to add.

setPrefix

public void setPrefix(java.lang.String prefix)

Sets the prefix to add.

getMappedFileName

public static java.lang.String getMappedFileName(java.lang.String prefix,
                                                 java.lang.String name)

Performs the mapping of a file name by adding a prefix.