public final class StructuredTextExpertFactory extends Object
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.
Modifier and Type | Method and Description |
---|---|
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(String type)
Obtains a IStructuredTextExpert instance for processing structured text with
the specified type handler.
|
static IStructuredTextExpert |
getExpert(String type,
StructuredTextEnvironment environment)
Obtains a IStructuredTextExpert instance for processing structured text with
the specified type handler and the specified environment.
|
static IStructuredTextExpert |
getStatefulExpert(String type)
Obtains a IStructuredTextExpert instance for processing structured text with
the specified type handler.
|
static IStructuredTextExpert |
getStatefulExpert(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.
|
public static IStructuredTextExpert getExpert()
StructuredTextProcessor.getDefaultSeparators()
public static IStructuredTextExpert getExpert(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.IllegalArgumentException
- if type
is not a known type
identifier.public static IStructuredTextExpert getExpert(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.IllegalArgumentException
- if type
is not a known type
identifier.public static IStructuredTextExpert getStatefulExpert(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.IllegalArgumentException
- if type
is not a known type
identifier.public static IStructuredTextExpert getStatefulExpert(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.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.IllegalArgumentException
- if the handler
is null
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.