com.ibm.xtools.common.ui.wizards.config

Class TemplateConfiguration

java.lang.Object

com.ibm.xtools.common.ui.wizards.config.TemplateConfiguration

public class TemplateConfiguration
extends java.lang.Object

The template configuration contains the basic information required to create a new model from a template.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.core.runtime.IPath	containerPath
protected java.util.Map<java.lang.String,IContentCreator>	contentCreators
protected java.lang.String	fileName
protected ITemplate	template

Constructor Summary

Constructors

Constructor and Description
TemplateConfiguration(ITemplate template) Constructs a new TemplateConfiguration for the given template data.

Method Summary

Modifier and Type	Method and Description
void	addContentCreator(java.lang.String key, IContentCreator contentCreator) Adds a content creator to be executed upon creation of the new model.
org.eclipse.core.runtime.IPath	getContainerPath() Get the container path location where the new model will be created.
IContentCreator	getContentCreator(java.lang.String key) Get a content creator which has been contributed already for the given key.
java.util.Collection<IContentCreator>	getContentCreators() Get a collection of all content creators.
java.lang.String	getFileName() Get the file name of the new model.
ITemplate	getTemplate() Get the template data.
void	setContainerPath(org.eclipse.core.runtime.IPath containerPath) Sets the container patch location where the new model will be create.
void	setFileName(java.lang.String fileName) Set the file name of the new model.

Methods inherited from class java.lang.Object

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

Field Detail

template

protected ITemplate template

fileName

protected java.lang.String fileName

containerPath

protected org.eclipse.core.runtime.IPath containerPath

contentCreators

protected java.util.Map<java.lang.String,IContentCreator> contentCreators

Constructor Detail

TemplateConfiguration

public TemplateConfiguration(ITemplate template)

Constructs a new TemplateConfiguration for the given template data.

Parameters:

template - the template data

Method Detail

getTemplate

public ITemplate getTemplate()

Get the template data.

Returns:

the template data.

getContainerPath

public org.eclipse.core.runtime.IPath getContainerPath()

Get the container path location where the new model will be created.

Returns:

the container path location

setContainerPath

public void setContainerPath(org.eclipse.core.runtime.IPath containerPath)

Sets the container patch location where the new model will be create.

Parameters:

containerPath - the container path location

getFileName

public java.lang.String getFileName()

Get the file name of the new model.

Returns:

the file name of the new model

setFileName

public void setFileName(java.lang.String fileName)

Set the file name of the new model.

Parameters:

fileName - the file name of the new model

addContentCreator

public void addContentCreator(java.lang.String key,
                              IContentCreator contentCreator)

Adds a content creator to be executed upon creation of the new model.

Parameters:

key - the content creator key

contentCreator - the content creator

getContentCreator

public IContentCreator getContentCreator(java.lang.String key)

Get a content creator which has been contributed already for the given key.

Parameters:

key - the content creator key

Returns:

the content creator for the given key

getContentCreators

public java.util.Collection<IContentCreator> getContentCreators()

Get a collection of all content creators.

Returns:

a collection of all content creators