com.aspose.email

Class StringComparisonField

java.lang.Object

com.aspose.email.QueryField

com.aspose.email.ComparisonField

com.aspose.email.StringComparisonField

public final class StringComparisonField
extends ComparisonField

Represents the string search field.

Field Summary

Fields inherited from class com.aspose.email.QueryField

FieldName, owner

Method Summary

Methods

Modifier and Type	Method and Description
MailQuery	contains(String value) Indicates that field in message must contain the specified value.
MailQuery	contains(String value, boolean ignoreCase) Indicates that field in message must contain the specified value.
protected MailQuery	createKey(String name, String value, String comparsionOperator) Creates the search key.
MailQuery	empty() Indicates that field in message must be empty.
MailQuery	equals(String value) Indicates that field in message must be equal to the specified value.
MailQuery	equals(String value, boolean ignoreCase) Indicates that field in message must be equal to the specified value.
int	hashCode() hashCode.
MailQuery	notContains(String value) Indicates that field in message must not contain the specified value.
MailQuery	notContains(String value, boolean ignoreCase) Indicates that field in message must not contain the specified value.
MailQuery	notEmpty() Indicates that field in message must not be empty.
MailQuery	notEquals(String value) Indicates that field in message must not be equal to the specified value.
MailQuery	notEquals(String value, boolean ignoreCase) Indicates that field in message must not be equal to the specified value.
StringComparisonField	setKQL(boolean isKQL) Gets or sets value which defines whether property is used for Keyword Query Language

Methods inherited from class com.aspose.email.ComparisonField

createKey, orderBy

Methods inherited from class java.lang.Object

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

Method Detail

createKey

protected MailQuery createKey(String name,
                  String value,
                  String comparsionOperator)

Creates the search key.

Overrides:

createKey in class ComparisonField

Parameters:

name - The field name.

value - The value.

comparsionOperator - The operator.

Returns:

MailQuery that represents search query.

contains

public final MailQuery contains(String value)

Indicates that field in message must contain the specified value.

Parameters:

value - The value.

Returns:

MailQuery that represents search query (one searching criterion).

contains

public final MailQuery contains(String value,
                 boolean ignoreCase)

Indicates that field in message must contain the specified value.

Parameters:

value - The value.

ignoreCase - true to ignore case during the comparison; otherwise, false.

Returns:

MailQuery that represents search query (one searching criterion).

Throws:

AsposeArgumentNullException - value;Field value should not be null or empty

notContains

public final MailQuery notContains(String value)

Indicates that field in message must not contain the specified value.

Parameters:

value - The value.

Returns:

MailQuery that represents search query (one searching criterion).

notContains

public final MailQuery notContains(String value,
                    boolean ignoreCase)

Indicates that field in message must not contain the specified value.

Parameters:

value - The value.

ignoreCase - true to ignore case during the comparison; otherwise, false.

Returns:

MailQuery that represents search query (one searching criterion).

hashCode

public int hashCode()

hashCode.

Overrides:

hashCode in class Object

Returns:

a int.

equals

public final MailQuery equals(String value)

Indicates that field in message must be equal to the specified value.

Parameters:

value - The value.

Returns:

MailQuery that represents search query (one searching criterion).

equals

public final MailQuery equals(String value,
               boolean ignoreCase)

Indicates that field in message must be equal to the specified value.

Parameters:

value - The value.

ignoreCase - true to ignore case during the comparison; otherwise, false.

Returns:

MailQuery that represents search query (one searching criterion).

notEquals

public final MailQuery notEquals(String value)

Indicates that field in message must not be equal to the specified value.

Parameters:

value - The value.

Returns:

MailQuery that represents search query (one searching criterion).

notEquals

public final MailQuery notEquals(String value,
                  boolean ignoreCase)

Indicates that field in message must not be equal to the specified value.

Parameters:

value - The value.

ignoreCase - true to ignore case during the comparison; otherwise, false.

Returns:

MailQuery that represents search query (one searching criterion).

empty

public final MailQuery empty()

Indicates that field in message must be empty.

Returns:

MailQuery that represents search query (one searching criterion).

setKQL

public final StringComparisonField setKQL(boolean isKQL)

Gets or sets value which defines whether property is used for Keyword Query Language

Parameters:

isKQL -

Returns:

notEmpty

public final MailQuery notEmpty()

Indicates that field in message must not be empty.

Returns:

MailQuery that represents search query (one searching criterion).