Package org.eclipse.equinox.bidi

Class StructuredTextTypeHandlerFactory

  • public final class StructuredTextTypeHandlerFactory
extends java.lang.Object
    Provides access to registered structured text handlers.

    A structured text handler is a subclass of StructuredTextTypeHandler adapted for a given type of structured text.

    The constants in this class are identifiers for structured text handlers which are defined and supported "out of the box" by this package. Text handler identifiers can be used when invoking StructuredTextProcessor.processTyped(String, String), or when invoking getExpert methods in StructuredTextExpertFactory.

    The getHandler(java.lang.String) method in this class can be used to get a structured text handler reference for one of the handlers defined in this package or for additional structured text handlers registered by plug-ins via the org.eclipse.equinox.bidi.bidiTypes extension point. Text handler references can be used when invoking StructuredTextExpertFactory.getStatefulExpert(StructuredTextTypeHandler, StructuredTextEnvironment).

    This class can be used without OSGi running, but only the structured text types declared as string constants in this class are available in that mode.

    Restriction:
    This class is not intended to be instantiated by clients.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String COMMA_DELIMITED
      Structured text handler identifier for comma-delimited lists, such as:
      static java.lang.String EMAIL
      Structured text handler identifier for e-mail addresses.
      static java.lang.String FILE
      Structured text handler identifier for directory and file paths.
      static java.lang.String JAVA
      Structured text handler identifier for Java code, possibly spanning multiple lines.
      static java.lang.String REGEX
      Structured text handler identifier for regular expressions, possibly spanning multiple lines.
      static java.lang.String SQL
      Structured text handler identifier for SQL statements, possibly spanning multiple lines.
      static java.lang.String UNDERSCORE
      Structured text handler identifier for compound names.
      static java.lang.String URL
      Structured text handler identifier for URLs.
      static java.lang.String XPATH
      Structured text handler identifier for XPath expressions.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static StructuredTextTypeHandler getHandler​(java.lang.String id)
      Obtains a structured text handler of a given type.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • COMMA_DELIMITED

        public static final java.lang.String COMMA_DELIMITED
        Structured text handler identifier for comma-delimited lists, such as: 
          part1,part2,part3
        See Also:
        Constant Field Values

      • EMAIL

        public static final java.lang.String EMAIL
        Structured text handler identifier for e-mail addresses.
        See Also:
        Constant Field Values

      • FILE

        public static final java.lang.String FILE
        Structured text handler identifier for directory and file paths.
        See Also:
        Constant Field Values

      • JAVA

        public static final java.lang.String JAVA
        Structured text handler identifier for Java code, possibly spanning multiple lines.
        See Also:
        Constant Field Values

      • REGEX

        public static final java.lang.String REGEX
        Structured text handler identifier for regular expressions, possibly spanning multiple lines.
        See Also:
        Constant Field Values

      • SQL

        public static final java.lang.String SQL
        Structured text handler identifier for SQL statements, possibly spanning multiple lines.
        See Also:
        Constant Field Values

      • UNDERSCORE

        public static final java.lang.String UNDERSCORE
        Structured text handler identifier for compound names. It expects text to be made of one or more parts separated by underscores: 
          part1_part2_part3
        See Also:
        Constant Field Values

      • URL

        public static final java.lang.String URL
        Structured text handler identifier for URLs.
        See Also:
        Constant Field Values

      • XPATH

        public static final java.lang.String XPATH
        Structured text handler identifier for XPath expressions.
        See Also:
        Constant Field Values

    • Method Detail

      • getHandler

        public static StructuredTextTypeHandler getHandler​(java.lang.String id)
        Obtains a structured text handler of a given type. Supported type ids are:
        • the String constants in StructuredTextTypeHandlerFactory
        • if OSGi is running, the types that have been contributed to the org.eclipse.equinox.bidi.bidiTypes extension point.
        Parameters:
        id - the string identifying a structured text handler
        Returns:
        a handler of the required type, or null if the type is unknown