Package xal.app.launcher

Class Rule

java.lang.Object

xal.app.launcher.Rule

All Implemented Interfaces:

xal.tools.data.DataListener

public class Rule
extends Object
implements xal.tools.data.DataListener

Rule for running an application with a specified wildcard pattern

Field Summary

Fields

Modifier and Type	Field	Description
static String	DATA_LABEL	DataAdaptor label used in reading and writing

Constructor Summary

Constructors

Constructor	Description
Rule()	Constructor
Rule(String pattern, String kind, String... commands)	Constructor
Rule(String pattern, String kind, List<String> commands)	Constructor
Rule(String pattern, String kind, List<String> commands, boolean excludes)	Primary Constructor

Method Summary

Modifier and Type	Method	Description
String	dataLabel()	provides the name used to identify the class in an external data source.
void	deleteCommandAtIndex(int index)	delete the rule at the specified index
boolean	excludes()	determine whether matching files are excluded
List<String>	getCommands()	get the commands
List<String>	getCommands(App application)	get the commands using the application's specific substitution for file path (%f) and name (%n)
static Rule	getInstance(xal.tools.data.DataAdaptor adaptor)	create an instance from a data adaptor
String	getKind()	get the kind
String	getPattern()	get the file wildcard pattern
void	insertCommandAtIndex(String command, int index)	insert a command at the specified index
boolean	matches(File file)	determine whether this rule matches the specified file
boolean	matches(App application)	determine whether this rule matches the specified application
boolean	matchesFileName(String fileName)	determine whether this rule matches the specified file name
void	setCommands(List<String> commands)	set the commands
void	setExcludes(boolean excludes)	set whether matching files are excluded
void	setKind(String kind)	set the kind
void	setPattern(String pattern)	set the file wildcard pattern
void	update(xal.tools.data.DataAdaptor adaptor)	Instructs the receiver to update its data based on the given adaptor.
void	write(xal.tools.data.DataAdaptor adaptor)	Instructs the receiver to write its data to the adaptor for external storage.

Methods inherited from class java.lang.Object

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

Field Detail

DATA_LABEL

public static final String DATA_LABEL

DataAdaptor label used in reading and writing

See Also:

Constant Field Values

Constructor Detail

Rule

public Rule(String pattern,
            String kind,
            List<String> commands,
            boolean excludes)

Primary Constructor

Rule

public Rule(String pattern,
            String kind,
            List<String> commands)

Constructor

Rule

public Rule(String pattern,
            String kind,
            String... commands)

Constructor

Rule

public Rule()

Constructor

Method Detail

getInstance

public static Rule getInstance(xal.tools.data.DataAdaptor adaptor)

create an instance from a data adaptor

getPattern

public String getPattern()

get the file wildcard pattern

setPattern

public void setPattern(String pattern)

set the file wildcard pattern

getCommands

public List<String> getCommands()

get the commands

setCommands

public void setCommands(List<String> commands)

set the commands

getCommands

public List<String> getCommands(App application)

get the commands using the application's specific substitution for file path (%f) and name (%n)

insertCommandAtIndex

public void insertCommandAtIndex(String command,
                                 int index)

insert a command at the specified index

deleteCommandAtIndex

public void deleteCommandAtIndex(int index)

delete the rule at the specified index

excludes

public boolean excludes()

determine whether matching files are excluded

setExcludes

public void setExcludes(boolean excludes)

set whether matching files are excluded

getKind

public String getKind()

get the kind

setKind

public void setKind(String kind)

set the kind

matches

public boolean matches(App application)

determine whether this rule matches the specified application

matches

public boolean matches(File file)

determine whether this rule matches the specified file

matchesFileName

public boolean matchesFileName(String fileName)

determine whether this rule matches the specified file name

dataLabel

public String dataLabel()

provides the name used to identify the class in an external data source.

Specified by:

dataLabel in interface xal.tools.data.DataListener

Returns:

The tag for this data node.

update

public void update(xal.tools.data.DataAdaptor adaptor)

Instructs the receiver to update its data based on the given adaptor.

Specified by:

update in interface xal.tools.data.DataListener

Parameters:

adaptor - The data adaptor corresponding to this object's data node.

write

public void write(xal.tools.data.DataAdaptor adaptor)

Instructs the receiver to write its data to the adaptor for external storage.

Specified by:

write in interface xal.tools.data.DataListener

Parameters:

adaptor - The data adaptor corresponding to this object's data node.