org.seedstack.business.specification

Class StringSpecification

java.lang.Object

org.seedstack.business.specification.StringSpecification

All Implemented Interfaces:

Specification<String>

Direct Known Subclasses:

StringEqualSpecification, StringMatchingSpecification

public abstract class StringSpecification
extends Object
implements Specification<String>

Base class for specifications that compare strings. Allows to specify string-related comparison options like trimming or case sensitivity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StringSpecification.Options Options used for comparing strings.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	expectedString
protected StringSpecification.Options	options

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StringSpecification(String expectedString, StringSpecification.Options options) Creates a string specification.

Method Summary

Modifier and Type	Method and Description
String	getExpectedString() Returns the expected string.
StringSpecification.Options	getOptions() Returns the comparison options.
boolean	isSatisfiedBy(String candidateValue) Evaluates if the candidate object passed as argument satisfies the specification.
protected abstract boolean	isSatisfiedByString(String candidateString)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.seedstack.business.specification.Specification

and, any, asPredicate, negate, none, or

Field Detail

expectedString

protected final String expectedString

options

protected final StringSpecification.Options options

Constructor Detail

StringSpecification

protected StringSpecification(String expectedString,
                              StringSpecification.Options options)

Creates a string specification.

Parameters:

expectedString - the string to compare the candidate against.

options - the comparison options.

Method Detail

isSatisfiedBy

public boolean isSatisfiedBy(String candidateValue)

Description copied from interface: Specification

Evaluates if the candidate object passed as argument satisfies the specification.

Specified by:

isSatisfiedBy in interface Specification<String>

Parameters:

candidateValue - the candidate object to check.

Returns:

true if the candidate object satisfies the specification, false otherwise.

isSatisfiedByString

protected abstract boolean isSatisfiedByString(String candidateString)

getExpectedString

public String getExpectedString()

Returns the expected string.

Returns:

the string that is compared against the candidate.

getOptions

public StringSpecification.Options getOptions()

Returns the comparison options.

Returns:

the comparison options.