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.
static void	copyAttributesFromTemplate(CreateFromTemplateHandler h, FileObject from, FileObject to) Copies template attributes over to the created file.
protected abstract List<FileObject>	createFromTemplate(CreateDescriptor desc) Handles the creation of new files.
protected static List<FileObject>	defaultCopyContents(CreateDescriptor origDescriptor, FileObject contentsParent, FileObject target) Copies the files or folders contained in the specified folder to the target.

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

copyAttributesFromTemplate

public static void copyAttributesFromTemplate(CreateFromTemplateHandler h,
                                              FileObject from,
                                              FileObject to)
                                       throws IOException

Copies template attributes over to the created file. Copies over from the source (template) to the target (usually the produced file), except attributes that parametrize template creation. By default, attributes that are prefixed with "template." are not copied. As the operation is not atomic, the method should be called in a FileSystem.runAtomicAction(org.openide.filesystems.FileSystem.AtomicAction). The "template" attribute is never copied.

Parameters:

h - the Handler responsible for file creation, usually the calling handler.

from - the original file

to - the target file

Throws:

IOException - if an I/O error occurs.

defaultCopyContents

protected static List<FileObject> defaultCopyContents(CreateDescriptor origDescriptor,
                                                      FileObject contentsParent,
                                                      FileObject target)
                                               throws IOException

Copies the files or folders contained in the specified folder to the target. The original descriptor can be passed in, since it has Lookup, parameters etc set up. They will be passed on to individual created files. The `contentsParent` may be null, in which case the CreateDescriptor.getTemplate() folder will be used.

Parameters:

origDescriptor - original descriptor to get parameters / lookup from

contentsParent - template folder whose contents should be copied

target - target folder

Returns:

created files

Throws:

IOException

Since:

1.23