net.sf.okapi.common

## Class StringSanitiser

- java.lang.Object
- - net.sf.okapi.common.StringSanitiser

- All Implemented Interfaces:
    Sanitiser<java.lang.String>

      public final class StringSanitiser
      extends java.lang.Object
      implements Sanitiser<java.lang.String>

  A string sanitiser.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `StringSanitiser.DoubleParsingFilter` A double parsing filter.
    `static class` | `StringSanitiser.IntegerParsingFilter` An integer parsing filter.
    `static class` | `StringSanitiser.TrimmingFilter` A trimming filter.

    - ### Nested classes/interfaces inherited from interface net.sf.okapi.common.Sanitiser

      `Sanitiser.Filter<T>`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `StringSanitiser(java.util.List<Sanitiser.Filter<java.lang.String>> filters)` Creates a string sanitiser.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `sanitise(java.lang.String value)` Sanitises a value.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### StringSanitiser

          public StringSanitiser(java.util.List<Sanitiser.Filter<java.lang.String>> filters)

      Creates a string sanitiser.
      Parameters:
        `filters` - The filters

  - ### Method Detail

    - #### sanitise

          public java.lang.String sanitise(java.lang.String value)

      Sanitises a value.
      Specified by:
        `sanitise` in interface `Sanitiser<java.lang.String>`
      Parameters:
        `value` - The value
      Returns:
        A sanitised value