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

Class ManualConversionTrigger

java.lang.Object

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

ca.cgjennings.apps.arkham.component.conversion.ManualConversionTrigger

All Implemented Interfaces:

ConversionTrigger

public class ManualConversionTrigger
extends AbstractConversionTrigger

A ConversionTrigger created when the user initiates a manual conversion (e.g. from the Edit menu). ManualConversionTrigger returns "manual" from getCause().

Since:

3.3

Author:

Henrik Rostedt

Constructor Summary

Constructors

Constructor	Description
ManualConversionTrigger(java.lang.String targetClassName, java.lang.String requiredExtensionName, java.lang.String requiredExtensionId, java.lang.String group)	Creates a new ManualConversionTrigger indicating that the user has requested a component conversion.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCause()	Returns a string identifying why the conversion was triggered.
java.lang.String	getGroup()	Returns the conversion group of the triggering conversion option.
java.lang.String	toString()

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

getRequiredExtensionId, getRequiredExtensionName, getTargetClassName

Methods inherited from class java.lang.Object

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

Constructor Detail

ManualConversionTrigger

public ManualConversionTrigger(java.lang.String targetClassName,
                               java.lang.String requiredExtensionName,
                               java.lang.String requiredExtensionId,
                               java.lang.String group)

Creates a new ManualConversionTrigger indicating that the user has requested a component conversion.

Parameters:

targetClassName - the identifier of the new component type

requiredExtensionName - the name of the required extension, or null if no extension is required

requiredExtensionId - the UUID of the required extension, or null if no extension is required

group - the conversion group the conversion option belongs to, or null if it is a direct conversion option

Method Detail

getGroup

public java.lang.String getGroup()

Returns the conversion group of the triggering conversion option. null is returned if it was a direct conversion option.

Returns:

the conversion group or null

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

toString

public java.lang.String toString()

Overrides:

toString in class AbstractConversionTrigger