Runtime

## Package org.eclipse.gmf.runtime.common.ui.services.parser

Provides the framework for the parser service.

See:
Description

Interface Summary
CommonParserHint: Defines common parser hints.
IParser: The interface for all parsers
IParserEditStatus: Status object for indicating the validity of an edit.
IParserProvider: The interface for all parser providers Must implement a method to return a parser from an IAdaptable hint

Class Summary
GetParserOperation: Operation to get a parser using an IAdaptable hint for the parser to be used
ParserEditStatus: Concrete implementation of the IParserEditStatus suitable for use or extending.
ParserOptions: This is a wrapper used for defining, setting, and retrieving flags that can be used for the parser operations that take a flags int as a parameter.
ParserService: The parser service which returns a parser for an IAdaptable.

## Package org.eclipse.gmf.runtime.common.ui.services.parser Description

Provides the framework for the parser service. Given an `IAdaptable` hint, the `ParserService` class contains a method to return a parser for the IAdaptable. This is performed using the `GetParserOperation`. From this method, the ParserService class provides implementations of convenience methods to obtain text for the IAdaptable and to determine whether or not the IAdaptable can be edited. Flags for the parser service may be defined in an interface with constants such as `CommonParserHint` or using a convenience wrapper such as `ParserOptions`.

## Using this Package

To implement a parser provider, implement `IParserProvider`, typically subclassing `AbstractProvider`. For on demand loading, consider implementing `IProviderPolicy` and in particular the `provides()` method. To implement the parser to be returned by the IParserProvider, implement the `IParser` interface.

## Package Specification

For more information on the Service Infrastructure, please see `org.eclipse.gmf.runtime.common.core.service.Service`

Runtime

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.