org.netbeans.api.templates

Class CreateFromTemplateHandler

java.lang.Object

org.netbeans.api.templates.CreateFromTemplateHandler

public abstract class CreateFromTemplateHandler
extends Object

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

An implementation of CreateHandler should honor CreateDescriptor.hasFreeExtension() and CreateDescriptor.isPreformatted().

Constructor Summary

Constructors

Constructor and Description
CreateFromTemplateHandler()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	accept(CreateDescriptor desc) Method that allows a handler to reject a file.
protected abstract List<FileObject>	createFromTemplate(CreateDescriptor desc) Handles the creation of new files.

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(CreateDescriptor desc)

Method that allows a handler to reject a file. If all handlers reject a file, regular processing defined in FileBuilder.createFromTemplate(org.openide.filesystems.FileObject, org.openide.filesystems.FileObject, java.lang.String, java.util.Map, org.netbeans.api.templates.FileBuilder.Mode) is going to take place.

Parameters:

desc - describes the request that is about to be performed

Returns:

true if this handler wants to handle the createFromTemplate operation

createFromTemplate

@NonNull
protected abstract List<FileObject> createFromTemplate(CreateDescriptor desc)
                                                         throws IOException

Handles the creation of new files. The Handler may create one or more files. The files should be ordered so that the "important" file (i.e. the one which is then presented to the user etc) is ordered first in the list.

Parameters:

desc - command objects that describes the file creation request

Returns:

the newly create file

Throws:

IOException - if something goes wrong with I/O