org.netbeans.api.templates

Enum FileBuilder.Mode

java.lang.Object

java.lang.Enum<FileBuilder.Mode>

org.netbeans.api.templates.FileBuilder.Mode

All Implemented Interfaces:

Serializable, Comparable<FileBuilder.Mode>

Enclosing class:

FileBuilder

public static enum FileBuilder.Mode
extends Enum<FileBuilder.Mode>

Determines the default procedure for copying the template in FileBuilder.createFromTemplate(org.openide.filesystems.FileObject, org.openide.filesystems.FileObject, java.lang.String, java.util.Map<java.lang.String, ?>, org.netbeans.api.templates.FileBuilder.Mode).

Enum Constant Summary

Enum Constants

Enum Constant and Description
COPY The template will be just copied.
FAIL The template will not be processed if no custom CreateFromTemplateHandler handles it.
FORMAT The template will be formatted using formatter.

Method Summary

Modifier and Type	Method and Description
static FileBuilder.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FileBuilder.Mode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FORMAT

public static final FileBuilder.Mode FORMAT

The template will be formatted using formatter.

COPY

public static final FileBuilder.Mode COPY

The template will be just copied.

FAIL

public static final FileBuilder.Mode FAIL

The template will not be processed if no custom CreateFromTemplateHandler handles it.

Method Detail

values

public static FileBuilder.Mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FileBuilder.Mode c : FileBuilder.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FileBuilder.Mode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null