oracle.jdeveloper.template
Class TemplateManagerImpl

java.lang.Object
  oracle.jdeveloper.template.TemplateManager
      oracle.jdeveloper.template.TemplateManagerImpl

public class TemplateManagerImpl
extends TemplateManager

Constructor Summary

TemplateManagerImpl()

Method Summary

void	addTemplateData(TemplateData templateData) Add a new TemplateData.
void	clear() Purge all registered TemplateData, except the default TemplateData.
java.util.List<AbstractTemplate>	findTemplateById(java.lang.String id) Search and returns a list of templates from all TemplateData stores starting with the default TemplateData that match id.
java.util.List<TemplateData>	getAllTemplateData() List of all templates from all TemplateData objects, starting with the default TemplateData.
java.util.List<AbstractTemplate>	getAllTemplates() Get all templates.
java.util.List<ApplicationTemplate>	getApplicationTemplates() Get a list of all Application templates registered with this TemplateManager.
DefaultTemplateData	getDefaultTemplateData() Get the default TemplateData store.
java.util.logging.Logger	getLogger() A Logger to log template-related messages.
java.util.List<ProjectTemplate>	getProjectTemplates() Get a list of all Project templates registered with this TemplateManager.
AbstractTemplate	getTemplateById(java.lang.String id) Returns a typed Template object by its unique identifier.
TemplateData	getTemplateData(java.net.URL url) Return TemplateData identified by a specific URL.
void	load(java.net.URL url) Load contents from a URL.
void	registerTemplate(AbstractTemplate template) Register a template into the default TemplateData.
void	registerTemplate(HashStructure hash) Register a HashSructure representing a template into the default Template.
TemplateData	removeTemplateData(TemplateData templateData) Remove a TemplateData.
TemplateData	removeTemplateData(java.net.URL url) Remove a template data store identified by a URL.
void	save(java.net.URL url) Save contents of TemplateManager to a URL.
void	setDefaultTemplateData(DefaultTemplateData td) Set the default TemplateData store.

Methods inherited from class oracle.jdeveloper.template.TemplateManager

getInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateManagerImpl

public TemplateManagerImpl()

Method Detail

getProjectTemplates

public java.util.List<ProjectTemplate> getProjectTemplates()

Description copied from class: TemplateManager

Get a list of all Project templates registered with this TemplateManager. Sorting order is same as described in getAllTemplates()

Specified by:

getProjectTemplates in class TemplateManager

Returns:

See Also:

TemplateManager.getAllTemplates()

getApplicationTemplates

public java.util.List<ApplicationTemplate> getApplicationTemplates()

Description copied from class: TemplateManager

Get a list of all Application templates registered with this TemplateManager. Sorting order is same as described in getAllTemplates()

Specified by:

getApplicationTemplates in class TemplateManager

Returns:

getAllTemplates

public java.util.List<AbstractTemplate> getAllTemplates()

Description copied from class: TemplateManager

Get all templates. The list includes the default TemplateData store, as well as all other registered TemplateData stores. List is unsorted and appears in the order in which the corresponding TemplateData stores were registered.

Specified by:

getAllTemplates in class TemplateManager

getTemplateById

public AbstractTemplate getTemplateById(java.lang.String id)

Returns a typed Template object by its unique identifier.

Parameters:

id - unique string identifier for the template.

Returns:

a Template object, or null if not found.

registerTemplate

public void registerTemplate(HashStructure hash)

Description copied from class: TemplateManager

Register a HashSructure representing a template into the default Template.

Specified by:

registerTemplate in class TemplateManager

registerTemplate

public void registerTemplate(AbstractTemplate template)

Description copied from class: TemplateManager

Register a template into the default TemplateData.

Specified by:

registerTemplate in class TemplateManager

getLogger

public java.util.logging.Logger getLogger()

Description copied from class: TemplateManager

A Logger to log template-related messages.

Specified by:

getLogger in class TemplateManager

Returns:

java.util.logging.Logger

save

public void save(java.net.URL url)
          throws java.io.IOException

Description copied from class: TemplateManager

Save contents of TemplateManager to a URL.

Specified by:

save in class TemplateManager

Throws:

java.io.IOException

load

public void load(java.net.URL url)
          throws java.io.IOException

Description copied from class: TemplateManager

Load contents from a URL.

Specified by:

load in class TemplateManager

Throws:

java.io.IOException

clear

public void clear()

Description copied from class: TemplateManager

Purge all registered TemplateData, except the default TemplateData.

Specified by:

clear in class TemplateManager

getDefaultTemplateData

public DefaultTemplateData getDefaultTemplateData()

Description copied from class: TemplateManager

Get the default TemplateData store. This store contains templates loaded by the Template hook via the extension manifests. Templates registered using the registerTemplate() method also get added to the default TemplateData.

Specified by:

getDefaultTemplateData in class TemplateManager

Returns:

setDefaultTemplateData

public void setDefaultTemplateData(DefaultTemplateData td)

Description copied from class: TemplateManager

Set the default TemplateData store.

Specified by:

setDefaultTemplateData in class TemplateManager

addTemplateData

public void addTemplateData(TemplateData templateData)

Description copied from class: TemplateManager

Add a new TemplateData. All TemplateData objects added to a TemplateManager instances must have unique URLs.

Specified by:

addTemplateData in class TemplateManager

removeTemplateData

public TemplateData removeTemplateData(TemplateData templateData)

Description copied from class: TemplateManager

Remove a TemplateData. This cannot be used to remove the default TemplateData.

Specified by:

removeTemplateData in class TemplateManager

Returns:

the removed TemplateData, or null if not found.

removeTemplateData

public TemplateData removeTemplateData(java.net.URL url)

Description copied from class: TemplateManager

Remove a template data store identified by a URL.

Specified by:

removeTemplateData in class TemplateManager

Parameters:

url - unique key url. The URL should be an exact literal match.

Returns:

findTemplateById

public java.util.List<AbstractTemplate> findTemplateById(java.lang.String id)

Description copied from class: TemplateManager

Search and returns a list of templates from all TemplateData stores starting with the default TemplateData that match id.

Use template.getParent() to find out which store each template belongs to.

Specified by:

findTemplateById in class TemplateManager

Returns:

getAllTemplateData

public java.util.List<TemplateData> getAllTemplateData()

Description copied from class: TemplateManager

List of all templates from all TemplateData objects, starting with the default TemplateData.

Specified by:

getAllTemplateData in class TemplateManager

getTemplateData

public TemplateData getTemplateData(java.net.URL url)

Description copied from class: TemplateManager

Return TemplateData identified by a specific URL. To retrieve thed default TemplateData, use getDefaultTemplateData()

Specified by:

getTemplateData in class TemplateManager

Returns: