|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.stanwood.media.actions.AbstractAction
public abstract class AbstractAction
Helper class that actions should extends so that they only have to implement action methods that are needed.
Constructor Summary | |
---|---|
AbstractAction()
|
Method Summary | |
---|---|
void |
finished(MediaDirectory dir)
This is called once for each action after they have finished performing on all media files within the media directory. |
void |
init(MediaDirectory dir)
This is called once before any of the media files are processed to allow the action to perform setup tasks |
boolean |
isTestMode()
Used to find out if test mode is enabled |
void |
performOnDirectory(MediaDirectory dir,
java.io.File file,
IActionEventHandler actionEventHandler)
This is called so the action can perform on directories within the media directory |
protected java.lang.String |
resolvePatterns(MediaDirectory dir,
java.lang.String input,
IVideo video,
java.io.File mediaFile,
java.lang.Integer part)
|
void |
setTestMode(boolean testMode)
Used to notify the action if test mode is enabled |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.stanwood.media.actions.IAction |
---|
perform, perform, setParameter |
Constructor Detail |
---|
public AbstractAction()
Method Detail |
---|
public void setTestMode(boolean testMode)
setTestMode
in interface IAction
testMode
- True if test mode is enabled, otherwise falsepublic boolean isTestMode()
isTestMode
in interface IAction
public void performOnDirectory(MediaDirectory dir, java.io.File file, IActionEventHandler actionEventHandler) throws ActionException
performOnDirectory
in interface IAction
dir
- The media directoryfile
- The directory the action is to perform onactionEventHandler
- Used to notify the action performer about changes
ActionException
- Thrown if their is a problem with the actionpublic void init(MediaDirectory dir) throws ActionException
init
in interface IAction
dir
- The media directory
ActionException
- Thrown if their is a problem with the actionpublic void finished(MediaDirectory dir) throws ActionException
finished
in interface IAction
dir
- The media directory
ActionException
- Thrown if their is a problem with the actionprotected java.lang.String resolvePatterns(MediaDirectory dir, java.lang.String input, IVideo video, java.io.File mediaFile, java.lang.Integer part) throws ActionException
ActionException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |