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
 java.lang.String formatClass(java.lang.Object object)
          Return the Java class name of object. e.g.
 java.lang.String formatEClassName(EObject eObject)
          Return the Ecore class name of object. e.g.
 java.lang.String formatName(java.lang.Object object)
          Return the name of object. e.g.
 java.lang.String formatPath(java.util.List<java.lang.String> pathName)
          Return a hierarchical path name. e.g.
 java.lang.String formatPath(java.util.List<java.lang.String> pathName, java.lang.String name)
          Return a hierarchically named name. e.g.
 java.lang.String formatQualifiedName(java.lang.Object object)
          Return the qualified name of an object. e.g.
 java.lang.String formatString(java.lang.String string)
          Return the string. e.g.
 java.lang.String formatType(java.lang.Object type)
          Return the type of object. e.g.
 

Method Detail

formatClass

java.lang.String formatClass(java.lang.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

java.lang.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

java.lang.String formatName(java.lang.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

java.lang.String formatQualifiedName(java.lang.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

java.lang.String formatPath(java.util.List<java.lang.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

java.lang.String formatPath(java.util.List<java.lang.String> pathName,
                            java.lang.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

java.lang.String formatString(java.lang.String string)
Return the string. e.g. "string"

Parameters:
string - to be formatted
Returns:
non-null string describing string

formatType

java.lang.String formatType(java.lang.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

Copyright 2002, 2007 IBM Corporation and others.
All Rights Reserved.