CreateFromTemplateHandler (Datasystems API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.openide.loaders 6.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.openide.loaders
Class CreateFromTemplateHandler

java.lang.Object
  org.openide.loaders.CreateFromTemplateHandler

public abstract class CreateFromTemplateHandler
extends Object
extends Object

This is an interface for smart templating that allows any module to intercept calls to DataObject.createFromTemplate(org.openide.loaders.DataFolder) and handle them themselves. The NetBeans IDE provides default implementation that allows use of Freemarker templating engine. Read more in the howto document.

Since:: 6.1

Constructor Summary

CreateFromTemplateHandler()


Method Summary

protected abstract boolean accept(FileObject orig)
          Method that allows a handler to reject a file.

protected abstract FileObject createFromTemplate(FileObject orig, FileObject f, String name, Map<String,Object> parameters)
          Handles the creation of new file.

Methods inherited from class java.lang.Object

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

Constructor Summary
`CreateFromTemplateHandler()`

Method Summary
`protected abstract boolean`	`accept(FileObject orig)` Method that allows a handler to reject a file.
`protected abstract FileObject`	`createFromTemplate(FileObject orig, FileObject f, String name, Map<String,Object> parameters)` Handles the creation of new file.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

CreateFromTemplateHandler

public CreateFromTemplateHandler()

Method Detail

accept

protected abstract boolean accept(FileObject orig)

Method that allows a handler to reject a file. If all handlers reject a file, regular processing defined in DataObject.handleCreateFromTemplate(org.openide.loaders.DataFolder, java.lang.String) is going to take place.

Parameters:: orig - the file of the template
Returns:: true if this handler wants to handle the createFromTemplate operation

createFromTemplate

protected abstract FileObject createFromTemplate(FileObject orig,
                                                 FileObject f,
                                                 String name,
                                                 Map<String,Object> parameters)
                                          throws IOException

Handles the creation of new file.

Parameters:: orig - the source file; f - the folder to create a file in; name - the name of new file to create in the folder; parameters - map of additional arguments as specified by registered CreateFromTemplateAttributesProviders
Returns:: the newly create file
Throws:: IOException - if something goes wrong with I/O