Package ca.cgjennings.apps.arkham.project

Class MergeSettings

java.lang.Object

ca.cgjennings.apps.arkham.project.TaskAction

ca.cgjennings.apps.arkham.project.TaskActionTree

ca.cgjennings.apps.arkham.project.MergeSettings

All Implemented Interfaces:

IconProvider, java.lang.Iterable<TaskAction>

public class MergeSettings
extends TaskActionTree

A task action that loads settings from a settings file into the shared settings or a game's settings. Useful when developing plug-ins that require certain settings to be available, such as DIY component scripts.

Since:

3.0

Author:

Chris Jennings

Constructor Summary

Constructors

Constructor	Description
MergeSettings()

Method Summary

Modifier and Type	Method	Description
void	add(int index, TaskAction ta)
boolean	appliesToSelection(Member[] members)	Returns true if this action is applicable to any of the specified Members.
TaskAction	get(int index)
java.lang.String	getLabel()	Returns the human-readable name of this action.
protected boolean	isAppliesToShortCircuited()	If this method returns true, then the evaluation of TaskActionTree.appliesToSelection(ca.cgjennings.apps.arkham.project.Member[]) and TaskActionTree.appliesTo(ca.cgjennings.apps.arkham.project.Project, ca.cgjennings.apps.arkham.project.Task, ca.cgjennings.apps.arkham.project.Member) will assume that every child action performs the same test.
java.util.Iterator<TaskAction>	iterator()
int	size()

Methods inherited from class ca.cgjennings.apps.arkham.project.TaskActionTree

add, appliesTo, findActionByName, getSectionIndex, indexOf, perform, remove, remove

Methods inherited from class ca.cgjennings.apps.arkham.project.TaskAction

applyToChildren, getActionName, getDescription, getIcon, performOnSelection, resolveTarget, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MergeSettings

public MergeSettings()

Method Detail

getLabel

public java.lang.String getLabel()

Description copied from class: TaskAction

Returns the human-readable name of this action.

Specified by:

getLabel in class TaskAction

Returns:

the name used to create menu items for this action, localized if possible

add

public void add(int index,
                TaskAction ta)

Overrides:

add in class TaskActionTree

get

public TaskAction get(int index)

Overrides:

get in class TaskActionTree

iterator

public java.util.Iterator<TaskAction> iterator()

Specified by:

iterator in interface java.lang.Iterable<TaskAction>

Overrides:

iterator in class TaskActionTree

size

public int size()

Overrides:

size in class TaskActionTree

appliesToSelection

public boolean appliesToSelection(Member[] members)

Description copied from class: TaskAction

Returns true if this action is applicable to any of the specified Members. By overriding this, you can modify whether an action is listed depending on which other members are selected. For example, you could create a command that can only be applied to a singleton selection by checking the length of members and returning false if it is not 1, and otherwise calling the super implementation.

Overrides:

appliesToSelection in class TaskActionTree

Parameters:

members - a list of zero or more members

Returns:

true is the action can be applied to at least one member

isAppliesToShortCircuited

protected boolean isAppliesToShortCircuited()

If this method returns true, then the evaluation of TaskActionTree.appliesToSelection(ca.cgjennings.apps.arkham.project.Member[]) and TaskActionTree.appliesTo(ca.cgjennings.apps.arkham.project.Project, ca.cgjennings.apps.arkham.project.Task, ca.cgjennings.apps.arkham.project.Member) will assume that every child action performs the same test. Therefore, if the first child action tested does not apply, none of them can apply and the search ends immediately. Otherwise, every child action will be tested to see if it applies until at least one is found that does or they all fail.

The base class returns false.

This action tree returns true since all of its children represent settings instances with which a settings file could be merged.

Overrides:

isAppliesToShortCircuited in class TaskActionTree

Returns:

true