info.magnolia.module.delta
Class AbstractTask

java.lang.Object
  extended by info.magnolia.module.delta.AbstractTask
All Implemented Interfaces:
Task
Direct Known Subclasses:
AbstractRepositoryTask, AddMainMenuItemTask, AddNewDefaultConfig, AddPermissionTask, AddRoleToUserTask, AddUserToGroupTask, BootstrapResourcesTask, CheckAndUpdateDefaultWorkflowDefinition, CheckMagnoliaDevelopProperty, CheckNodesForMixVersionable, ConditionalDelegateTask, InstallWorkflowDefinitionTask, ModuleFilesExtraction, PartialBootstrapTask, PropertyValuesTask, RegisterMgnlDeletedType, RegisterServletTask, RegisterWorkspaceForCacheFlushingTask, SetDefaultPublicURI, SetupModuleRepositoriesTask, WarnTask, WebappBootstrap

public abstract class AbstractTask
extends Object
implements Task

Abstract implementation of the Task interface which handles the mandatory properties name and description.

Version:
$Revision: $ ($Author: $)
Author:
gjoseph

Field Summary
protected  org.slf4j.Logger log
          Logger that can be reused in subclasses.
 
Constructor Summary
AbstractTask(String taskName, String taskDescription)
           
 
Method Summary
 String getDescription()
          Description what will happen during the execution.
 String getName()
          Description of what has changed.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface info.magnolia.module.delta.Task
execute
 

Field Detail

log

protected org.slf4j.Logger log
Logger that can be reused in subclasses.

Constructor Detail

AbstractTask

public AbstractTask(String taskName,
                    String taskDescription)
Method Detail

getName

public String getName()
Description copied from interface: Task
Description of what has changed. Example: "New ACL configuration"

Specified by:
getName in interface Task

getDescription

public String getDescription()
Description copied from interface: Task
Description what will happen during the execution. Example: "Bootstraps the new configuration for the ACL dialogs." A good-citizen task description should be written in the third person, be understandable and respect capitalization and punctuation rules. (start with capital letter, end with a dot)

Specified by:
getDescription in interface Task

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2003-2012 Magnolia International Ltd.. All Rights Reserved.