Package ca.cgjennings.apps.arkham.component.conversion

Class UpgradeConversionTrigger

java.lang.Object

ca.cgjennings.apps.arkham.component.conversion.AbstractConversionTrigger

ca.cgjennings.apps.arkham.component.conversion.UpgradeConversionTrigger

All Implemented Interfaces:

ConversionTrigger

public class UpgradeConversionTrigger
extends AbstractConversionTrigger

A ConversionTrigger created by GameComponents after being read from file to indicate that the component need to be converted to a new component type. UpgradeConversionTrigger returns "upgrade" from getCause().

Since:

3.3

Author:

Henrik Rostedt

Constructor Summary

Constructors

Constructor	Description
UpgradeConversionTrigger(java.lang.String targetClassName)	Creates a new UpgradeConversionTrigger indicating a component needs to be upgraded to another component type.
UpgradeConversionTrigger(java.lang.String targetClassName, java.lang.String requiredExtensionName, java.lang.String requiredExtensionId)	Creates a new UpgradeConversionTrigger indicating a component needs to be upgraded to another component type.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCause()	Returns a string identifying why the conversion was triggered.

Methods inherited from class ca.cgjennings.apps.arkham.component.conversion.AbstractConversionTrigger

getRequiredExtensionId, getRequiredExtensionName, getTargetClassName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UpgradeConversionTrigger

public UpgradeConversionTrigger(java.lang.String targetClassName)

Creates a new UpgradeConversionTrigger indicating a component needs to be upgraded to another component type. Use UpgradeConversionTrigger(String, String, String) if the component type belongs to another extension.

Parameters:

targetClassName - the identifier of the new component type

UpgradeConversionTrigger

public UpgradeConversionTrigger(java.lang.String targetClassName,
                                java.lang.String requiredExtensionName,
                                java.lang.String requiredExtensionId)

Creates a new UpgradeConversionTrigger indicating a component needs to be upgraded to another component type. Use UpgradeConversionTrigger(String) if the component type belongs to the same extension.

Parameters:

targetClassName - the identifier of the new component type

requiredExtensionName - the name of the required extension

requiredExtensionId - the UUID of the required extension

Method Detail

getCause

public java.lang.String getCause()

Description copied from interface: ConversionTrigger

Returns a string identifying why the conversion was triggered. Should generally correspond to the trigger type.

Returns:

the conversion cause