Eclipse Platform
Kepler (4.3)

org.eclipse.equinox.bidi
Class StructuredTextTypeHandlerFactory

java.lang.Object
  extended by org.eclipse.equinox.bidi.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 in StructuredTextTypeHandlerFactory and as string constants in this class are available in that mode.

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

Field Summary
static java.lang.String COMMA_DELIMITED
          Structured text handler identifier for comma-delimited lists, such as: part1,part2,part3
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 MATH
          Structured text handler identifier for basic arithmetic expressions.
static java.lang.String PROPERTY
          Structured text handler identifier for property file statements.
static java.lang.String REGEXP
          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 SYSTEM_USER
          Structured text handler identifier for strings with the following format: system(user)
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
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

MATH

public static final java.lang.String MATH
Structured text handler identifier for basic arithmetic expressions.

Currently supported operators are: +-/*()=

This set my be extended in the future.

See Also:
Constant Field Values

PROPERTY

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

See Also:
Constant Field Values

REGEXP

public static final java.lang.String REGEXP
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

SYSTEM_USER

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

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.

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
Kepler (4.3)

Guidelines for using Eclipse APIs.

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