Eclipse Platform
Release 4.2

org.eclipse.equinox.bidi
Class STextTypeHandlerFactory

java.lang.Object
  extended by org.eclipse.equinox.bidi.STextTypeHandlerFactory

public final class STextTypeHandlerFactory
extends Object

Provides access to registered structured text handlers.

A structured text handler is a subclass of STextTypeHandler 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 STextProcessor.processTyped(String, String), or when invoking getExpert methods in STextExpertFactory.

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. Text handler references can be used when invoking STextExpertFactory.getStatefulExpert(STextTypeHandler, STextEnvironment).

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

Field Summary
static String COMMA_DELIMITED
          Structured text handler identifier for comma-delimited lists, such as: part1,part2,part3
static String EMAIL
          Structured text handler identifier for e-mail addresses.
static String FILE
          Structured text handler identifier for directory and file paths.
static String JAVA
          Structured text handler identifier for Java code, possibly spanning multiple lines.
static String PROPERTY
          Structured text handler identifier for property file statements.
static String REGEXP
          Structured text handler identifier for regular expressions, possibly spanning multiple lines.
static String RTL_ARITHMETIC
          Structured text handler identifier for arithmetic expressions, possibly with a RTL base direction.
static String SQL
          Structured text handler identifier for SQL statements, possibly spanning multiple lines.
static String SYSTEM_USER
          Structured text handler identifier for strings with the following format: system(user)
static String UNDERSCORE
          Structured text handler identifier for compound names.
static String URL
          Structured text handler identifier for URLs.
static String XPATH
          Structured text handler identifier for XPath expressions.
 
Method Summary
static STextTypeHandler getHandler(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

PROPERTY

public static final String PROPERTY
Structured text handler identifier for property file statements. It expects the following format:
  name=value
 

See Also:
Constant Field Values

UNDERSCORE

public static final 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

COMMA_DELIMITED

public static final String COMMA_DELIMITED
Structured text handler identifier for comma-delimited lists, such as:
  part1,part2,part3
 

See Also:
Constant Field Values

SYSTEM_USER

public static final String SYSTEM_USER
Structured text handler identifier for strings with the following format:
  system(user)
 

See Also:
Constant Field Values

FILE

public static final String FILE
Structured text handler identifier for directory and file paths.

See Also:
Constant Field Values

EMAIL

public static final String EMAIL
Structured text handler identifier for e-mail addresses.

See Also:
Constant Field Values

URL

public static final String URL
Structured text handler identifier for URLs.

See Also:
Constant Field Values

REGEXP

public static final String REGEXP
Structured text handler identifier for regular expressions, possibly spanning multiple lines.

See Also:
Constant Field Values

XPATH

public static final String XPATH
Structured text handler identifier for XPath expressions.

See Also:
Constant Field Values

JAVA

public static final String JAVA
Structured text handler identifier for Java code, possibly spanning multiple lines.

See Also:
Constant Field Values

SQL

public static final String SQL
Structured text handler identifier for SQL statements, possibly spanning multiple lines.

See Also:
Constant Field Values

RTL_ARITHMETIC

public static final String RTL_ARITHMETIC
Structured text handler identifier for arithmetic expressions, possibly with a RTL base direction.

See Also:
Constant Field Values
Method Detail

getHandler

public static STextTypeHandler getHandler(String id)
Obtains a structured text handler of a given type.

Parameters:
id - the string identifying a structured text handler.
Returns:
a handler of the required type, or null if the type is unknown.

Eclipse Platform
Release 4.2

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2013. All rights reserved.