org.eclipse.tigerstripe.workbench.plugins
Interface ICopyRule

All Superinterfaces:

IRule

public interface ICopyRule
extends IRule

Base interface for Pluggable Plugin Copy Rule A copy rule is a global rule that is capabable of copying files/directories from either the containing plugin or the current project to a specified directory location.

Since:

2.2.2.1

Author:

erdillon

Field Summary

static int	FROM_PLUGIN
static int	FROM_PROJECT

Fields inherited from interface org.eclipse.tigerstripe.workbench.plugins.IRule

ALLARTIFACTS, ALLASSOCIATIONCLASSES, ALLASSOCIATIONS, ALLDATATYPES, ALLDEPENDENCIES, ALLENTITIES, ALLENUMERATIONS, ALLEVENTS, ALLEXCEPTIONS, ALLPACKAGES, ALLPLUGINCONFIG, ALLQUERIES, ALLSESSIONS, ALLUPDATEPROCEDURES, ANNOTATIONCONTEXT, ARTIFACT, ARTIFACT_CLASS, ARTIFACTS, ASSOCIATIONCLASSES, ASSOCIATIONS, DATATYPES, DEPENDENCIES, DIAGRAMGENERATOR, ENTITIES, ENUMERATIONS, EVENTS, EXCEPTIONS, EXP, INCLUDEDEPENDENCIES, MANAGER, MANAGERSESSION, OVERWRITEFILES, PACKAGES, PLUGINCONFIG, PLUGINDIR, QUERIES, REPORT, RUNTIME, SESSIONS, SUPPRESSFILES, TSPROJECT, TSPROJECTHANDLE, UPDATEPROCEDURES

Method Summary

int	getCopyFrom() Gets the value of the copyFrom
java.lang.String	getFilesetMatch() Returns the fileset match String for this copy rule.
java.lang.String	getToDirectory() Gets the directory that this rule is going to copy to.
void	setCopyFrom(int from) Sets the copy from.
void	setFilesetMatch(java.lang.String filesetMatch) Set the fileset match.
void	setToDirectory(java.lang.String toDirectory) Sets the directory to copy to, relative to target generation directory

Methods inherited from interface org.eclipse.tigerstripe.workbench.plugins.IRule

getDescription, getLabel, getName, getType, isEnabled, setDescription, setEnabled, setName

Field Detail

FROM_PLUGIN

static final int FROM_PLUGIN

See Also:

Constant Field Values

FROM_PROJECT

static final int FROM_PROJECT

See Also:

Constant Field Values

Method Detail

setToDirectory

void setToDirectory(java.lang.String toDirectory)

Sets the directory to copy to, relative to target generation directory

Parameters:

toDirectory -

getToDirectory

java.lang.String getToDirectory()

Gets the directory that this rule is going to copy to. The directory is relative to the target generation directory

Returns:

setCopyFrom

void setCopyFrom(int from)

Sets the copy from. Valid values are FROM_PLUGIN or FROM_PROJECT

Parameters:

from -

getCopyFrom

int getCopyFrom()

Gets the value of the copyFrom

Returns:

setFilesetMatch

void setFilesetMatch(java.lang.String filesetMatch)

Set the fileset match. Expects standard use of "*".

Parameters:

filesetMatch -

getFilesetMatch

java.lang.String getFilesetMatch()

Returns the fileset match String for this copy rule.

Returns: