org.eclipse.sphinx.emf.resource

Interface IModelConverterDescription

All Known Implementing Classes:

ModelConverterDescription

public interface IModelConverterDescription

Represents the user relevant information about an IModelConverter. User relevant means information which the user should know and which is to be displayed to her/him within the UI.

Since:

0.7.0

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBehaviorDetails() Returns details on this IModelConverter's behavior.
java.lang.String	getWarning() Returns a message containing information about side effects of this IModelConverter.
boolean	hasBehaviorDetails() Determines if this IModelConverterDescription provides any details on the IModelConverter's behavior.
boolean	hasWarning() Determines if this IModelConverterDescription provides any warning.
boolean	isEmpty() Determines if any user relevant information is provided by this IModelConverterDescription.

Method Detail

getBehaviorDetails

java.lang.String getBehaviorDetails()

Returns details on this IModelConverter's behavior. The details are intended to be displayed to the user in order to inform her/him about the characteristics and the behavior of this IModelConverter.

Returns:

A description of this IModelConverter's behavior.

getWarning

java.lang.String getWarning()

Returns a message containing information about side effects of this IModelConverter. This message is intended to be displayed to the user to warn her/him about the side effects which might result from the usage of this IModleConverter.

Returns:

A message intended to be displayed to the user as a warning.

isEmpty

boolean isEmpty()

Determines if any user relevant information is provided by this IModelConverterDescription. User relevant means any data which is to be displayed to the user within the UI.

Returns:

true if no user relevant information is provided by this IModelConverterDescription, false otherwise.

hasWarning

boolean hasWarning()

Determines if this IModelConverterDescription provides any warning.

Returns:

true if this IModelConverterDescription provides a warning.

hasBehaviorDetails

boolean hasBehaviorDetails()

Determines if this IModelConverterDescription provides any details on the IModelConverter's behavior.

Returns:

true if this IModelConverterDescription provides behavior details, false otherwise.