org.netbeans.api.templates

Interface CreateFromTemplateDecorator

public interface CreateFromTemplateDecorator

Decorator for templating. The decorator will pre- or post-process the main file creation. Decorators are called by the infrastructure, in the declaration order, before the template file is processed and after it is processed, depending on isBeforeCreation() and isAfterCreation() return values. A decorator may perform both pre- and post- processing.

First the decorator is asked to accept(org.netbeans.api.templates.CreateDescriptor) the creation process; if it does not, it will not be invoked at all. Before/after main file creation the decorate(org.netbeans.api.templates.CreateDescriptor, java.util.List<org.openide.filesystems.FileObject>) method is called to perform its magic. Any reported additional files will be returned as part of FileBuilder.build() result.

Since:

1.9

Method Summary

Modifier and Type	Method and Description
boolean	accept(CreateDescriptor desc) Determines whether the decorator is willing to participate in creation.
List<FileObject>	decorate(CreateDescriptor desc, List<FileObject> createdFiles) Extends the creation process.
boolean	isAfterCreation() Determines if the decorator should be called after template processing.
boolean	isBeforeCreation() Determines if the decorator should be called before template processing.

Method Detail

isBeforeCreation

boolean isBeforeCreation()

Determines if the decorator should be called before template processing. Pre-decorators can setup the environment before the main file creation takes place.

Returns:

true, if the decorator should be called before template processing

isAfterCreation

boolean isAfterCreation()

Determines if the decorator should be called after template processing. Post-decorators can make additional (e.g. settings, registrations) adjustments.

Returns:

true, if the decorator should be called after template processing

accept

boolean accept(CreateDescriptor desc)

Determines whether the decorator is willing to participate in creation. If the decorator returns false, its decorate(org.netbeans.api.templates.CreateDescriptor, java.util.List<org.openide.filesystems.FileObject>) will not be called. It

Parameters:

desc - describes the request that is about to be performed

Returns:

true if this decorator wants to participate in files creation

decorate

@CheckForNull
List<FileObject> decorate(@NonNull
                                        CreateDescriptor desc,
                                        @NonNull
                                        List<FileObject> createdFiles)
                                 throws IOException

Extends the creation process. The decorator may alter the created file (it is the first in the returned list) or create additional files. In case it creates files, it must return list of the added files.

If the decorator is not interested, it should return simply null.

Parameters:

desc - command objects that describes the file creation request

createdFiles - files created so far as part of the template creation

Returns:

the newly create file(s)

Throws:

IOException - if something goes wrong with I/O