io.github.privacystreams.commons.string

Class StringOperators

java.lang.Object

io.github.privacystreams.commons.string.StringOperators

@PSOperatorWrapper
public class StringOperators
extends java.lang.Object

A helper class to access string-related functions

Constructor Summary

Constructors

Constructor and Description
StringOperators()

Method Summary

Modifier and Type	Method and Description
static Function<Item,java.lang.Boolean>	contains(java.lang.String stringField, java.lang.String searchString) Check whether the string value of a field contains a certain substring.
static Function<Item,java.lang.String>	elide(java.lang.String stringField, int start, int end) Elide a substring in the string value of a field.
static Function<Item,java.lang.Integer>	indexOf(java.lang.String stringField, java.lang.String searchString) Get the index of a substring in the string value of a field.
static Function<Item,java.lang.Integer>	length(java.lang.String stringField) Get the length of the string value of a field.
static Function<Item,java.lang.String>	md5(java.lang.String stringField) Get the MD5-hashed value of the string value of a field.
static Function<Item,java.lang.String>	replace(java.lang.String stringField, java.lang.String searchString, java.lang.String replaceString) Replace a substring to a new string in the string value of a field.
static Function<Item,java.lang.String>	sha1(java.lang.String stringField) Get the SHA1-hashed value of the string value of a field.
static Function<Item,java.lang.String>	sha256(java.lang.String stringField) Get the SHA256-hashed value of the string value of a field.
static Function<Item,java.lang.String>	subString(java.lang.String stringField, int start, int end) Get a substring of the string value of a field.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringOperators

public StringOperators()

Method Detail

contains

public static Function<Item,java.lang.Boolean> contains(java.lang.String stringField,
                                                        java.lang.String searchString)

Check whether the string value of a field contains a certain substring.

Parameters:

stringField - the name of the string field

searchString - the substring to search

Returns:

the function.

md5

public static Function<Item,java.lang.String> md5(java.lang.String stringField)

Get the MD5-hashed value of the string value of a field.

Parameters:

stringField - the name of the string field to perform hash.

Returns:

the function.

sha1

public static Function<Item,java.lang.String> sha1(java.lang.String stringField)

Get the SHA1-hashed value of the string value of a field.

Parameters:

stringField - the name of the string field to perform hash.

Returns:

the function.

sha256

public static Function<Item,java.lang.String> sha256(java.lang.String stringField)

Get the SHA256-hashed value of the string value of a field.

Parameters:

stringField - the name of the string field to perform hash.

Returns:

the function.

indexOf

public static Function<Item,java.lang.Integer> indexOf(java.lang.String stringField,
                                                       java.lang.String searchString)

Get the index of a substring in the string value of a field.

Parameters:

stringField - the name of the string field

searchString - the substring to search

Returns:

the function

length

public static Function<Item,java.lang.Integer> length(java.lang.String stringField)

Get the length of the string value of a field.

Parameters:

stringField - the name of the string field to calculate length

Returns:

the function

replace

public static Function<Item,java.lang.String> replace(java.lang.String stringField,
                                                      java.lang.String searchString,
                                                      java.lang.String replaceString)

Replace a substring to a new string in the string value of a field.

Parameters:

stringField - the name of the string field

searchString - the substring to search

replaceString - the string used to replace the searchString

Returns:

the function

subString

public static Function<Item,java.lang.String> subString(java.lang.String stringField,
                                                        int start,
                                                        int end)

Get a substring of the string value of a field.

Parameters:

stringField - the name of the string field to calculate length

start - the position to start from, negative means count back from the end of the String by this many characters

end - the position to end at (exclusive), negative means count back from the end of the String by this many characters

Returns:

the function

elide

public static Function<Item,java.lang.String> elide(java.lang.String stringField,
                                                    int start,
                                                    int end)

Elide a substring in the string value of a field.

Parameters:

stringField - the name of the string field to calculate length

start - the position to start from, negative means count back from the end of the String by this many characters

end - the position to end at (exclusive), negative means count back from the end of the String by this many characters

Returns:

the function