com.facebook.buck.cxx.toolchain

Enum HeaderMode

java.lang.Object

java.lang.Enum<HeaderMode>

com.facebook.buck.cxx.toolchain.HeaderMode

All Implemented Interfaces:

FlavorConvertible, Serializable, Comparable<HeaderMode>

public enum HeaderMode
extends Enum<HeaderMode>
implements FlavorConvertible

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEADER_MAP_ONLY Creates the header map that references the headers directly in the source tree.
SYMLINK_TREE_ONLY Creates the tree of symbolic links of headers.
SYMLINK_TREE_WITH_HEADER_MAP Creates the tree of symbolic links of headers and creates the header map that references the symbolic links to the headers.
SYMLINK_TREE_WITH_HEADERS_MODULEMAP Creates the tree of symbolic links of headers and creates a module map that references the symbolic links to the headers.
SYMLINK_TREE_WITH_UMBRELLA_HEADER_MODULEMAP Creates the tree of symbolic links of headers and creates a module map that references the symbolic links to the headers.

Method Summary

Modifier and Type	Method and Description
static HeaderMode	forModuleMapMode(ModuleMapMode moduleMapMode) Returns the appropriate header mode for module map mode.
Flavor	getFlavor()
boolean	includesModuleMap() Returns whether or not the header mode will include a module map.
static HeaderMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static HeaderMode[]	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

SYMLINK_TREE_ONLY

public static final HeaderMode SYMLINK_TREE_ONLY

Creates the tree of symbolic links of headers.

HEADER_MAP_ONLY

public static final HeaderMode HEADER_MAP_ONLY

Creates the header map that references the headers directly in the source tree.

SYMLINK_TREE_WITH_HEADER_MAP

public static final HeaderMode SYMLINK_TREE_WITH_HEADER_MAP

Creates the tree of symbolic links of headers and creates the header map that references the symbolic links to the headers.

SYMLINK_TREE_WITH_HEADERS_MODULEMAP

public static final HeaderMode SYMLINK_TREE_WITH_HEADERS_MODULEMAP

Creates the tree of symbolic links of headers and creates a module map that references the symbolic links to the headers. The generated module map will refer to explicit headers.

SYMLINK_TREE_WITH_UMBRELLA_HEADER_MODULEMAP

public static final HeaderMode SYMLINK_TREE_WITH_UMBRELLA_HEADER_MODULEMAP

Creates the tree of symbolic links of headers and creates a module map that references the symbolic links to the headers. The generated module map will refer to an umbrella header, with the same name as the library.

Method Detail

values

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

Returns:

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

valueOf

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

getFlavor

public Flavor getFlavor()

Specified by:

getFlavor in interface FlavorConvertible

forModuleMapMode

public static HeaderMode forModuleMapMode(ModuleMapMode moduleMapMode)

Returns the appropriate header mode for module map mode.

Parameters:

moduleMapMode - The module map mode to convert.

Returns:

The equivalent header mode.

includesModuleMap

public boolean includesModuleMap()

Returns whether or not the header mode will include a module map.

Returns:

true if the header mode will include a module map, otherwise false.