com.neeve.tools

Enum AdmCodeGenerator.GenerateParameter

java.lang.Object

java.lang.Enum<AdmCodeGenerator.GenerateParameter>

com.neeve.tools.AdmCodeGenerator.GenerateParameter

All Implemented Interfaces:

Serializable, Comparable<AdmCodeGenerator.GenerateParameter>

Enclosing class:

AdmCodeGenerator

public static enum AdmCodeGenerator.GenerateParameter
extends Enum<AdmCodeGenerator.GenerateParameter>

Contains definitions of all parameters of code generator

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABSOLUTE Generate all files in output directory (instead of a namespace based directory structure relative to output directory).
ADDITIONAL_COPY_DIRS Additional locations where to copy model and idl files.
BUILD_INFO Build time information such as timestamp and machine being built on.
CODEGEN_EVENT_LISTENER_PROPERTIES Subscribe to code generation events.
CODEGEN_EVENT_LISTENERS Subscribe to code generation events.
EMPTY_IF_NULL_ARRAY Instructs the code generator return empty arrays instead of null for unset array fields.
INCREMENTAL_BUILD Trigger incremental code generation - run only if something changed since last run.
MODEL_URL The input file, Required.
MODELS_DIR Base directory for the referenced files.
NAMESPACE Namespace of model parsed from the input file (overrides namespace in model file if supplied).
OUT_DIR Base out directory for the generated files.
PROTO_DIR Additional directory in which to search for imported .proto files.
XPCOMPAT Wire compatibility between protobuf and xbuf generated classes.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MODEL_URL

public static final AdmCodeGenerator.GenerateParameter MODEL_URL

The input file, Required.

MODELS_DIR

public static final AdmCodeGenerator.GenerateParameter MODELS_DIR

Base directory for the referenced files. Optional

OUT_DIR

public static final AdmCodeGenerator.GenerateParameter OUT_DIR

Base out directory for the generated files. Required

XPCOMPAT

public static final AdmCodeGenerator.GenerateParameter XPCOMPAT

Wire compatibility between protobuf and xbuf generated classes. Optional

EMPTY_IF_NULL_ARRAY

public static final AdmCodeGenerator.GenerateParameter EMPTY_IF_NULL_ARRAY

Instructs the code generator return empty arrays instead of null for unset array fields. Required Default = false

NAMESPACE

public static final AdmCodeGenerator.GenerateParameter NAMESPACE

Namespace of model parsed from the input file (overrides namespace in model file if supplied). Optional

ABSOLUTE

public static final AdmCodeGenerator.GenerateParameter ABSOLUTE

Generate all files in output directory (instead of a namespace based directory structure relative to output directory). Required

PROTO_DIR

public static final AdmCodeGenerator.GenerateParameter PROTO_DIR

Additional directory in which to search for imported .proto files. Optional

BUILD_INFO

public static final AdmCodeGenerator.GenerateParameter BUILD_INFO

Build time information such as timestamp and machine being built on. Optional

INCREMENTAL_BUILD

public static final AdmCodeGenerator.GenerateParameter INCREMENTAL_BUILD

Trigger incremental code generation - run only if something changed since last run. Required Default false

ADDITIONAL_COPY_DIRS

public static final AdmCodeGenerator.GenerateParameter ADDITIONAL_COPY_DIRS

Additional locations where to copy model and idl files. Required Default File[0]

CODEGEN_EVENT_LISTENERS

public static final AdmCodeGenerator.GenerateParameter CODEGEN_EVENT_LISTENERS

Subscribe to code generation events. Instances of AdmCodeGenerator.CodegenListener. Not required Default CodegenListener[0]

CODEGEN_EVENT_LISTENER_PROPERTIES

public static final AdmCodeGenerator.GenerateParameter CODEGEN_EVENT_LISTENER_PROPERTIES

Subscribe to code generation events. Instances of AdmCodeGenerator.CodegenListener. Not required Default Empty Map

Method Detail

values

public static AdmCodeGenerator.GenerateParameter[] 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 (AdmCodeGenerator.GenerateParameter c : AdmCodeGenerator.GenerateParameter.values())
    System.out.println(c);

Returns:

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

valueOf

public static AdmCodeGenerator.GenerateParameter 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