RegExpFileMapper (Plexus IO Components 3.5.0 API)

java.lang.Object

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

org.codehaus.plexus.components.io.filemappers.RegExpFileMapper

All Implemented Interfaces:: FileMapper

@Named("regexp") public class RegExpFileMapper extends AbstractFileMapper

Implementation of a file mapper, which uses regular expressions.

Field Summary

Fields

Modifier and Type

Field

Description

static final String

ROLE_HINT

The regexp mappers role-hint: "regexp".
Constructor Summary

Constructors

Constructor

Description

RegExpFileMapper()
Method Summary

Modifier and Type

Method

Description

String

getMappedFileName(String pName)

Checks the input and returns it without modifications.

String

getPattern()

Returns the regular expression pattern.

boolean

getReplaceAll()

Returns, whether to replace the first occurrence of the pattern (default), or all.

String

getReplacement()

Returns the replacement string.

void

setPattern(String pPattern)

Sets the regular expression pattern.

void

setReplaceAll(boolean pReplaceAll)

Sets, whether to replace the first occurrence of the pattern (default), or all.

void

setReplacement(String pReplacement)

Sets the replacement string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- ROLE_HINT
  public static final String ROLE_HINT
  
  The regexp mappers role-hint: "regexp".
  
  See Also:
  
  Constant Field Values
Constructor Details
- RegExpFileMapper
  
  public RegExpFileMapper()
Method Details
- setPattern
  
  public void setPattern(String pPattern)
  
  Sets the regular expression pattern.
- getPattern
  
  public String getPattern()
  
  Returns the regular expression pattern.
- setReplacement
  
  public void setReplacement(String pReplacement)
  
  Sets the replacement string.
- getReplacement
  
  public String getReplacement()
  
  Returns the replacement string.
- getReplaceAll
  
  public boolean getReplaceAll()
  
  Returns, whether to replace the first occurrence of the pattern (default), or all.
- setReplaceAll
  
  public void setReplaceAll(boolean pReplaceAll)
  
  Sets, whether to replace the first occurrence of the pattern (default), or all.
- getMappedFileName
  
  @Nonnull public String getMappedFileName(@Nonnull String pName)
  
  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:
  
  pName - The source name.
  
  Returns:
  
  The target name.