IProjectTemplateProcessor Interface

com.bea.ide.workspace.project
IProjectTemplateProcessor Interface

public interface IProjectTemplateProcessor

Handles loading of a project template. IProjectTemplateProcessor implementations must have a two argument constructor that takes an IProjectTemplate and an IContext.

If a processor has not been declared in the template xml, Workshop will use a default processor. The default processor calls IContext.loadAllContent() from its load() method. It calls IContext.checkAllContent() from its check() method and will return a string if checkAllContent() returns a non-empty list.

Nested Class Summary

public static interfaceIProjectTemplateProcessor.IContext
           Represents a specific project context that the processor will operate on.

Method Summary

public String
check()
Called to check whether a project context is up to date per a project template.
public boolean
load()
Called to load a project template into a project context.

Method Detail

check() Method

public String check()
Called to check whether a project context is up to date per a project template. The processor will use the template and context passed to its constructor, and return an message describing the state of the project with regards to this project template. Null should be returned if applying the template would result in no changes to the project.

Returns

Message describing what action this processor would take if load were called, or null if no action would be performed.

load() Method

public boolean load()
Called to load a project template into a project context. The processor will use the template and context passed to its constructor.

Returns

true on success, false if operation failed to complete.