org.modelio.api.module.context.i18n

Interface I18nSupport

public interface I18nSupport

Define the I18n services provided by the module.

Since:

3.5

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription(NoteType element) Get the I18n'ed description for a NoteType.
java.lang.String	getDescription(Profile element) Get the I18n'ed description for a Profile.
java.lang.String	getDescription(PropertyDefinition pdef) Get the I18n'ed description for a PropertyDefinition.
java.lang.String	getDescription(ResourceType element) Get the I18n'ed description for a ResourceType.
java.lang.String	getDescription(Stereotype element) Get the I18n'ed description for a Stereotype.
java.lang.String	getDescription(TagType element) Get the I18n'ed description for a TagType.
java.util.ResourceBundle	getI18N() The most basic service: get the ResourceBundle of the module.
java.lang.String	getLabel(NoteType noteType) Get the I18n'ed label for a NoteType
java.lang.String	getLabel(Profile element) Get the I18n'ed label for a Profile.
java.lang.String	getLabel(PropertyDefinition pdef) Get the I18n'ed label for a PropertyDefinition
java.lang.String	getLabel(ResourceType docType) Get the I18n'ed label for a ResourceType.
java.lang.String	getLabel(Stereotype stereotype) Get the I18n'ed label for a Stereotype.
java.lang.String	getLabel(TagType tagType) Get the I18n'ed label for a TagType
java.lang.String	getString(java.lang.String key) Get the I18n'ed label for a given key

Method Detail

getDescription

java.lang.String getDescription(PropertyDefinition pdef)

Get the I18n'ed description for a PropertyDefinition.

Parameters:

pdef - the property definition to get the description for.

Returns:

the property definition's description, computed from the module's i18n bundle.

getDescription

java.lang.String getDescription(NoteType element)

Get the I18n'ed description for a NoteType.

Parameters:

pdef - the NoteType to get the description for.

Returns:

the NoteType's description, computed from the module's i18n bundle.

Since:

Modelio Valkyrie 3.8

getDescription

java.lang.String getDescription(TagType element)

Get the I18n'ed description for a TagType.

Parameters:

pdef - the TagType to get the description for.

Returns:

the TagType's description, computed from the module's i18n bundle.

Since:

Modelio Valkyrie 3.8

getDescription

java.lang.String getDescription(Stereotype element)

Get the I18n'ed description for a Stereotype.

Parameters:

pdef - the Stereotype to get the description for.

Returns:

the Stereotype's description, computed from the module's i18n bundle.

Since:

Modelio Valkyrie 3.8

getDescription

java.lang.String getDescription(ResourceType element)

Get the I18n'ed description for a ResourceType.

Parameters:

pdef - the ResourceType to get the description for.

Returns:

the ResourceType's description, computed from the module's i18n bundle.

Since:

Modelio Valkyrie 3.8

getDescription

java.lang.String getDescription(Profile element)

Get the I18n'ed description for a Profile.

Parameters:

element - the Profile to get the description for.

Returns:

the profile description, computed from the module's i18n bundle.

Since:

Modelio Valkyrie 3.8

getI18N

java.util.ResourceBundle getI18N()

The most basic service: get the ResourceBundle of the module.

Returns:

the module's i18n bundle.

getLabel

java.lang.String getLabel(Stereotype stereotype)

Get the I18n'ed label for a Stereotype.

Parameters:

stereotype - the stereotype to get the label for.

Returns:

the stereotype's label, computed from the module's i18n bundle.

getLabel

java.lang.String getLabel(TagType tagType)

Get the I18n'ed label for a TagType

Parameters:

tagType - the tag type to get the label for.

Returns:

the tag type's label, computed from the module's i18n bundle.

getLabel

java.lang.String getLabel(NoteType noteType)

Get the I18n'ed label for a NoteType

Parameters:

noteType - the note type to get the label for.

Returns:

the note type's label, computed from the module's i18n bundle.

getLabel

java.lang.String getLabel(ResourceType docType)

Get the I18n'ed label for a ResourceType.

Parameters:

docType - the resource type to get the label for.

Returns:

the resource type's label, computed from the module's i18n bundle.

getLabel

java.lang.String getLabel(PropertyDefinition pdef)

Get the I18n'ed label for a PropertyDefinition

Parameters:

pdef - the property definition to get the label for.

Returns:

the property definition's label, computed from the module's i18n bundle.

getLabel

java.lang.String getLabel(Profile element)

Get the I18n'ed label for a Profile.

Parameters:

docType - the profile to get the label for.

Returns:

the profile label, computed from the module's i18n bundle.

Since:

Modelio Valkyrie 3.8

getString

java.lang.String getString(java.lang.String key)

Get the I18n'ed label for a given key

Parameters:

key - the key for the desired string.

Returns:

the string for the given key if any. Otherwise, the key as is.