Interface ConversionTrigger
-
- All Known Implementing Classes:
AbstractConversionTrigger
,ManualConversionTrigger
,UpgradeConversionTrigger
public interface ConversionTrigger
AConversionTrigger
object must be provided when initiating conversion of aGameComponent
.- Since:
- 3.3
- Author:
- Henrik Rostedt
- See Also:
ConversionSession#convertGameComponent(ConversionTrigger, ca.cgjennings.apps.arkham.component.GameComponent)
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static ConversionTrigger
create(java.lang.String cause, java.lang.String targetClassName, java.lang.String extensionName, java.lang.String extensionId)
Creates a default conversion trigger that is suitable for most conversion tasks.java.lang.String
getCause()
Returns a string identifying why the conversion was triggered.java.lang.String
getRequiredExtensionId()
Returns the UUID of required extension for the new component type.java.lang.String
getRequiredExtensionName()
Returns the name of required extension for the new component type.java.lang.String
getTargetClassName()
Returns the identifier for the new component type to convert theGameComponent
to.
-
-
-
Method Detail
-
getCause
java.lang.String getCause()
Returns a string identifying why the conversion was triggered. Should generally correspond to the trigger type.- Returns:
- the conversion cause
-
getTargetClassName
java.lang.String getTargetClassName()
Returns the identifier for the new component type to convert theGameComponent
to.- Returns:
- the target component type identifier
-
getRequiredExtensionName
java.lang.String getRequiredExtensionName()
Returns the name of required extension for the new component type. Returnsnull
if the extension is the same as the original component type.- Returns:
- the name of the required extension
-
getRequiredExtensionId
java.lang.String getRequiredExtensionId()
Returns the UUID of required extension for the new component type. Returnsnull
if the extension is the same as the original component type.- Returns:
- the UUID of the required extension
-
create
static ConversionTrigger create(java.lang.String cause, java.lang.String targetClassName, java.lang.String extensionName, java.lang.String extensionId)
Creates a default conversion trigger that is suitable for most conversion tasks.- Parameters:
cause
- A non-null string describing the reason for the conversion.targetClassName
- The non-null name of the class map class of the new component.extensionName
- An optional description of the extension required by the target component.extensionId
- An optional UUID or CatalogID string of the extension required by the target component.- Returns:
- A basic conversion trigger for the specified cause. The returned
trigger is guaranteed not to be an instance of
AbstractConversionTrigger
(and by extension,UpgradeConversionTrigger
).
-
-