StringRegexReplace (uk.gov.gchq.koryphe:koryphe 2.5.2 API)

java.lang.Object
- uk.gov.gchq.koryphe.function.KorypheFunction<String,String>
- - uk.gov.gchq.koryphe.impl.function.StringRegexReplace

All Implemented Interfaces:

Function<String,String>
```
public class StringRegexReplace
extends KorypheFunction<String,String>
```
A StringRegexReplace is a Function which takes an input string and applies the provided regular expression to find matching substrings to replace. It then replaces all of these matches with the provided replacement string.

See Also:

StringReplace

Constructor Summary

Constructors
Constructor Description

StringRegexReplace()

StringRegexReplace(String regex, String replacement)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`apply(String input)`
`boolean`	`equals(Object o)`
`String`	`getRegex()`
`String`	`getReplacement()`
`int`	`hashCode()`
`void`	`setRegex(String regex)`
`void`	`setReplacement(String replacement)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Function
andThen, compose

Constructor Detail

StringRegexReplace
```
public StringRegexReplace()
```

StringRegexReplace

public StringRegexReplace(String regex,
                          String replacement)

Method Detail

apply
```
public String apply(String input)
```

getRegex
```
public String getRegex()
```

setRegex

public void setRegex(String regex)

getReplacement
```
public String getReplacement()
```

setReplacement

public void setReplacement(String replacement)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class KorypheFunction<String,String>

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class KorypheFunction<String,String>