|
Eclipse Platform Kepler (4.3) |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.equinox.bidi.advanced.StructuredTextExpertFactory
public final class StructuredTextExpertFactory
Obtains IStructuredTextExpert instances.
An IStructuredTextExpert
instance (called in short an "expert") provides
the advanced methods to process a certain type of structured text, and
is thus related to a specific
structured text type handler
.
There are two kinds of experts:
getStatefulExpert(java.lang.String)
.getExpert()
.Only the stateful kind can remember the state established by a call to a text processing method and transmit it as initial state in the next call to a text processing method.
In other words, the methods
IStructuredTextExpert.getState()
,
IStructuredTextExpert.setState(java.lang.Object)
and
IStructuredTextExpert.clearState()
of
IStructuredTextExpert
are inoperative for experts which are not stateful.
Using a stateful expert is more resource intensive, thus not stateful experts should be used when feasible.
Method Summary | |
---|---|
static IStructuredTextExpert |
getExpert()
Obtains a IStructuredTextExpert instance for processing structured text with a default type handler segmenting the text according to default separators. |
static IStructuredTextExpert |
getExpert(java.lang.String type)
Obtains a IStructuredTextExpert instance for processing structured text with the specified type handler. |
static IStructuredTextExpert |
getExpert(java.lang.String type,
StructuredTextEnvironment environment)
Obtains a IStructuredTextExpert instance for processing structured text with the specified type handler and the specified environment. |
static IStructuredTextExpert |
getStatefulExpert(java.lang.String type)
Obtains a IStructuredTextExpert instance for processing structured text with the specified type handler. |
static IStructuredTextExpert |
getStatefulExpert(java.lang.String type,
StructuredTextEnvironment environment)
Obtains a IStructuredTextExpert instance for processing structured text with the specified type handler and the specified environment. |
static IStructuredTextExpert |
getStatefulExpert(StructuredTextTypeHandler handler,
StructuredTextEnvironment environment)
Obtains a IStructuredTextExpert instance for processing structured text with the specified type handler and the specified environment. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static IStructuredTextExpert getExpert()
StructuredTextProcessor.getDefaultSeparators()
public static IStructuredTextExpert getExpert(java.lang.String type)
type
- the identifier for the required type handler. This identifier
may be one of those listed in StructuredTextTypeHandlerFactory
or it may be have been registered by a plug-in.
java.lang.IllegalArgumentException
- if type
is not a known type
identifier.public static IStructuredTextExpert getExpert(java.lang.String type, StructuredTextEnvironment environment)
type
- the identifier for the required type handler. This identifier
may be one of those listed in StructuredTextTypeHandlerFactory
or it may be have been registered by a plug-in.environment
- the current environment, which may affect the behavior of
the expert. This parameter may be specified as
null
, in which case the
StructuredTextEnvironment.DEFAULT
environment should be assumed.
java.lang.IllegalArgumentException
- if type
is not a known type
identifier.public static IStructuredTextExpert getStatefulExpert(java.lang.String type)
type
- the identifier for the required type handler. This identifier
may be one of those listed in StructuredTextTypeHandlerFactory
or it may be have been registered by a plug-in.
java.lang.IllegalArgumentException
- if type
is not a known type
identifier.public static IStructuredTextExpert getStatefulExpert(java.lang.String type, StructuredTextEnvironment environment)
type
- the identifier for the required type handler. This identifier
may be one of those listed in StructuredTextTypeHandlerFactory
or it may be have been registered by a plug-in.environment
- the current environment, which may affect the behavior of
the expert. This parameter may be specified as
null
, in which case the
StructuredTextEnvironment.DEFAULT
environment should be assumed.
java.lang.IllegalArgumentException
- if type
is not a known type
identifier.public static IStructuredTextExpert getStatefulExpert(StructuredTextTypeHandler handler, StructuredTextEnvironment environment)
handler
- the type handler instance. It may have been obtained using
StructuredTextTypeHandlerFactory.getHandler(String)
or
by instantiating a type handler.environment
- the current environment, which may affect the behavior of
the expert. This parameter may be specified as
null
, in which case the
StructuredTextEnvironment.DEFAULT
environment should be assumed.
java.lang.IllegalArgumentException
- if type
is not a known type
identifier.
|
Eclipse Platform Kepler (4.3) |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2012. All rights reserved.