Package org.apache.uima.cas

# Interface FSStringConstraint

All Superinterfaces:
  `FSConstraint`, `Serializable`

public interface FSStringConstraint extends FSConstraint
Interface for a String constraint. A String constraint supports equality testing to a given string. After creating this constraint, use the `equals(String)` method to specify the string that the constraint uses in its testing.

To use the constraint, invoke its `match(String)` method, passing the value to test. You can also embed this test with a path specification, using the `ConstraintFactory.embedConstraint(FeaturePath, FSConstraint)` method, and use it to test feature structures, or combine it with other tests using the `ConstraintFactory.and(FSMatchConstraint, FSMatchConstraint)` and `ConstraintFactory.or(FSMatchConstraint, FSMatchConstraint)` methods.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `equals(String s)`
  String value of matched FS must match input String.
  `boolean`
  `match(String s)`
  Check if String matches defined constraints.

- ## Method Details

  - ### equals

    void equals(String s)
    String value of matched FS must match input String.
    Parameters:
      `s` - The string that the matched FS must equal.

  - ### match

    boolean match(String s)
    Check if String matches defined constraints.
    Parameters:
      `s` - The String to be checked.
    Returns:
      `true` iff the String satisfies the constraints.