org.eclipse.ocl.lpg

Interface FormattingHelper

All Known Implementing Classes:

AbstractFormattingHelper

public interface FormattingHelper

A FormattingHelper provides string contributions to problem messages endeavouring to be as helpful as possible even when faced with malformed or null objects.

Method Summary

Modifier and Type	Method and Description
String	formatClass(Object object) Return the Java class name of object.
String	formatEClassName(EObject eObject) Return the Ecore class name of object.
String	formatName(Object object) Return the name of object.
String	formatPath(List<String> pathName) Return a hierarchical path name.
String	formatPath(List<String> pathName, String name) Return a hierarchically named name.
String	formatQualifiedName(Object object) Return the qualified name of an object.
String	formatString(String string) Return the string.
String	formatType(Object type) Return the type of object.

Method Detail

formatClass

String formatClass(Object object)

Return the Java class name of object. e.g. "org.eclipse.ocl.FormattingHelper".

Parameters:

object - to be formatted

Returns:

non-null string describing the class of object

formatEClassName

String formatEClassName(EObject eObject)

Return the Ecore class name of object. e.g. "EOperation"

Parameters:

eObject - to be formatted

Returns:

non-null string describing the Ecore class of object

formatName

String formatName(Object object)

Return the name of object. e.g. "name". The name may be obtained by using known name methods such as ENamedElement.getName().

Parameters:

object - to be formatted

Returns:

non-null string describing the name of object

formatQualifiedName

String formatQualifiedName(Object object)

Return the qualified name of an object. e.g. "A::B::name".

Parameters:

object - to be formatted

Returns:

non-null string describing the qualified name of the object

formatPath

String formatPath(List<String> pathName)

Return a hierarchical path name. e.g. "A::B::C"

Parameters:

pathName - to be formatted

Returns:

non-null string describing the pathName

formatPath

String formatPath(List<String> pathName,
                  String name)

Return a hierarchically named name. e.g. "A::B::C.D"

Parameters:

pathName - to be formatted

name - to be suffixed

Returns:

non-null string describing the class of object

formatString

String formatString(String string)

Return the string. e.g. "string"

Parameters:

string - to be formatted

Returns:

non-null string describing string

formatType

String formatType(Object type)

Return the type of object. e.g. "Set(String)". The type may be obtained by using known type methods such as ETypedElement.getType().

Parameters:

type - object to be formatted

Returns:

non-null string describing the type of object