StringTruncate (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.StringTruncate

All Implemented Interfaces:

Function<String,String>
```
public class StringTruncate
extends KorypheFunction<String,String>
```
A StringTruncate is a Function which truncates an input String to a specified length, optionally appending ellipsis characters to denote that the string was truncated.

Constructor Summary

Constructors
Constructor Description

StringTruncate()

StringTruncate(int length)

StringTruncate(int length, boolean ellipses)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`apply(String input)`
`boolean`	`equals(Object o)`
`int`	`getLength()`
`int`	`hashCode()`
`boolean`	`isEllipses()`
`void`	`setEllipses(boolean ellipses)`
`void`	`setLength(int length)`

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

StringTruncate
```
public StringTruncate()
```

StringTruncate
```
public StringTruncate(int length)
```

StringTruncate

public StringTruncate(int length,
                      boolean ellipses)

Method Detail

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

getLength
```
public int getLength()
```

setLength
```
public void setLength(int length)
```

isEllipses
```
public boolean isEllipses()
```

setEllipses

public void setEllipses(boolean ellipses)

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

equals in class KorypheFunction<String,String>

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

hashCode in class KorypheFunction<String,String>