org.netbeans.api.templates

Class CreateDescriptor

java.lang.Object

org.netbeans.api.templates.CreateDescriptor

public final class CreateDescriptor
extends Object

Describes file creation request. The description is produced by the FileBuilder and is sent out to CreateFromTemplateAttributes and CreateFromTemplateHandler SPIs as the context for their work.

The class is not thread-safe. Do not access the descriptor from a thread other than executing the CreateFromTemplateHandler callbacks.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FREE_FILE_EXTENSION Parameter to enable free file extension mode.
static String	PREFORMATTED_TEMPLATE Specifies that no formatting or indentation should be performed on the template.

Method Summary

Modifier and Type	Method and Description
Locale	getLocale() Provides the desired user locale for creating the template
String	getName() Provides the desired name for the created file.
Map<String,Object>	getParameters() Provides access to the complete parameter map.
String	getProposedName() Provides a name proposed for the file.
FileObject	getTarget()
FileObject	getTemplate()
<T> T	getValue(String n) Provides value for the named key.
boolean	hasFreeExtension() Specifies whether the extension should be taken from the specified name, or the extension is fixed to the template's one.
boolean	isPreformatted()

Methods inherited from class java.lang.Object

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

Field Detail

FREE_FILE_EXTENSION

public static final String FREE_FILE_EXTENSION

Parameter to enable free file extension mode. By default, the extension of the newly created file will be inherited from the template. But if FileBuilder.createFromTemplate(org.openide.filesystems.FileObject, org.openide.filesystems.FileObject, java.lang.String, java.util.Map, org.netbeans.api.templates.FileBuilder.Mode) is called with this parameter set to Boolean.TRUE and the file name already seems to include an extension (*.*), the handler should not append any extension from the template.

Since:

org.openide.loaders 7.16

See Also:

Templates.SimpleTargetChooserBuilder.freeFileExtension, Constant Field Values

PREFORMATTED_TEMPLATE

public static final String PREFORMATTED_TEMPLATE

Specifies that no formatting or indentation should be performed on the template. The parameter can be specified as parameter to the template (possibly through layer registration of the template. Value is kept for backwards compatibility, but the attribute does not apply just to java templates.

It's responsibility of CreateFromTemplateHandler to pay attention to this value.

See Also:

Constant Field Values

Method Detail

getTemplate

@NonNull
public FileObject getTemplate()

Returns:

the template file

getTarget

@NonNull
public FileObject getTarget()

Returns:

the target folder

getName

@CheckForNull
public String getName()

Provides the desired name for the created file. null can be returned to indicate the filename should be derived automatically.

Returns:

name for the created file

getProposedName

@NonNull
public String getProposedName()

Provides a name proposed for the file. If the caller specified the name, the value will be the same as CreateDescriptor.getName(). A handler is encouraged to use the proposed name if it does not require a certain naming scheme.

Returns:

proposed name for the created file

getLocale

@NonNull
public Locale getLocale()

Provides the desired user locale for creating the template

Returns:

locale

getValue

@CheckForNull
public <T> T getValue(String n)

Provides value for the named key. Values are originally provided by the caller, or the template itself; values can be provided also by CreateFromTemplateAttributes implementors.

Type Parameters:

T - value type.

Parameters:

n - key name

Returns:

named value or null if the key does not exist/has no value.

getParameters

@NonNull
public Map<String,Object> getParameters()

Provides access to the complete parameter map.

Returns:

readonly string-value map.

hasFreeExtension

public boolean hasFreeExtension()

Specifies whether the extension should be taken from the specified name, or the extension is fixed to the template's one.

Returns:

true, if the name contains already the extension.

isPreformatted

public boolean isPreformatted()