com.facebook.buck.apple.clang

Enum ModuleMapMode

java.lang.Object

java.lang.Enum<ModuleMapMode>

com.facebook.buck.apple.clang.ModuleMapMode

All Implemented Interfaces:

Serializable, Comparable<ModuleMapMode>

public enum ModuleMapMode
extends Enum<ModuleMapMode>

Enumerates the module map generation modes that Buck supports.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEADERS Generate a module map with explicit "header" declarations.
UMBRELLA_HEADER Generate a module map that requires an umbrella header.

Method Summary

Modifier and Type	Method and Description
boolean	shouldGenerateMissingUmbrellaHeader() If true, an umbrella header for the module should be created if it is not already present in the user-declared exported header files.
static ModuleMapMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ModuleMapMode[]	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

HEADERS

public static final ModuleMapMode HEADERS

Generate a module map with explicit "header" declarations.

UMBRELLA_HEADER

public static final ModuleMapMode UMBRELLA_HEADER

Generate a module map that requires an umbrella header.

Method Detail

values

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

Returns:

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

valueOf

public static ModuleMapMode 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

shouldGenerateMissingUmbrellaHeader

public boolean shouldGenerateMissingUmbrellaHeader()

If true, an umbrella header for the module should be created if it is not already present in the user-declared exported header files. Otherwise, no umbrella header should be automatically generated.