Package com.devonfw.module.basic.common.api.query

Class StringSearchConfigTo

java.lang.Object

com.devonfw.module.basic.common.api.to.AbstractTo

com.devonfw.module.basic.common.api.query.StringSearchConfigTo

All Implemented Interfaces:

Serializable

public class StringSearchConfigTo
extends AbstractTo

TO for the options to search for a string value.

Since:

3.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
StringSearchConfigTo()

Method Summary

Modifier and Type	Method	Description
LikePatternSyntax	getLikeSyntax()
StringSearchOperator	getOperator()
boolean	isIgnoreCase()
boolean	isMatchSubstring()
static StringSearchConfigTo	of(LikePatternSyntax syntax)
static StringSearchConfigTo	of(StringSearchOperator operator)
void	setIgnoreCase(boolean ignoreCase)
void	setLikeSyntax(LikePatternSyntax likeSyntax)
void	setMatchSubstring(boolean matchSubstring)
void	setOperator(StringSearchOperator operator)

Methods inherited from class com.devonfw.module.basic.common.api.to.AbstractTo

toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringSearchConfigTo

public StringSearchConfigTo()

Method Detail

isIgnoreCase

public boolean isIgnoreCase()

Returns:

true to ignore the case, false otherwise (to search case-sensitive).

setIgnoreCase

public void setIgnoreCase(boolean ignoreCase)

Parameters:

ignoreCase - new value of isIgnoreCase().

isMatchSubstring

public boolean isMatchSubstring()

Returns:

matchSubstring true if search string shall also match substrings of the string values to search on.

setMatchSubstring

public void setMatchSubstring(boolean matchSubstring)

Parameters:

matchSubstring - new value of isMatchSubstring().

getLikeSyntax

public LikePatternSyntax getLikeSyntax()

Returns:

the LikePatternSyntax of the search string used to do a LIKE-search, null for no LIKE-search. Shall be null if operator is neither null nor StringSearchOperator.LIKE.

setLikeSyntax

public void setLikeSyntax(LikePatternSyntax likeSyntax)

Parameters:

likeSyntax - new value of getLikeSyntax().

getOperator

public StringSearchOperator getOperator()

Returns:

operator the StringSearchOperator used to search. If null a "magic auto mode" is used where StringSearchOperator.LIKE is used in case the search string contains wildcards and StringSearchOperator.EQ is used otherwise.

setOperator

public void setOperator(StringSearchOperator operator)

Parameters:

operator - new value of getOperator().

of

public static StringSearchConfigTo of(StringSearchOperator operator)

Parameters:

operator - the StringSearchOperator.

Returns:

a new StringSearchConfigTo with the given config.

of

public static StringSearchConfigTo of(LikePatternSyntax syntax)

Parameters:

syntax - the LikePatternSyntax.

Returns:

a new StringSearchConfigTo with the given config.