manifold.preprocessor.definitions

Class Definitions

java.lang.Object

manifold.preprocessor.definitions.Definitions

Direct Known Subclasses:

ServiceDefinitions

public class Definitions
extends java.lang.Object

Models definitions as a hierarchy of maps. Searches for a definition in leaf-first order where the leaf definitions are controlled by the #define and #undef directives in the compiling source file. Parent definitions correspond with the following:

• build.properties files in the source file's directory ancestry
• Custom compiler arguments provided by the -Akey[=value] javac command line option
• Compiler and JVM environment settings such as Java source version, JPMS mode, operating system, etc.
• Custom service provider implementations of SymbolProvider. See BuildVariantSymbols.

Note the effects of #define and #undef are limited to the file scope. This means #define definitions are not available to other files. Similarly, parent definitions masked with #undef are not affected in other files.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUILD_PROPERTIES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Definitions(Definitions root, IFile definitionsSource, java.util.Map<java.lang.String,java.lang.String> definitions)
	Definitions(IFile definitionsSource)

Method Summary

Modifier and Type	Method and Description
void	clear()
java.lang.String	define(java.lang.String def) Define def in the source file's local definition space.
java.lang.String	define(java.lang.String def, java.lang.String value) Define def in the source file's local definition space with value.
boolean	equals(java.lang.Object o)
protected Definitions	getParent()
protected Definitions	getRoot()
protected IFile	getSourceFile()
java.lang.String	getValue(java.lang.String def)
int	hashCode()
boolean	isDefined(java.lang.String def)
protected java.util.Map<java.lang.String,java.lang.String>	loadEnvironmentDefinitions()
protected Definitions	loadParentDefinitions()
java.lang.String	undef(java.lang.String def) Remove def from the File's local definition space.

Methods inherited from class java.lang.Object

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

Field Detail

BUILD_PROPERTIES

public static final java.lang.String BUILD_PROPERTIES

See Also:

Constant Field Values

Constructor Detail

Definitions

public Definitions(IFile definitionsSource)

Definitions

protected Definitions(Definitions root,
                      IFile definitionsSource,
                      java.util.Map<java.lang.String,java.lang.String> definitions)

Method Detail

getRoot

protected Definitions getRoot()

getSourceFile

protected IFile getSourceFile()

getParent

protected Definitions getParent()

loadParentDefinitions

protected Definitions loadParentDefinitions()

loadEnvironmentDefinitions

protected java.util.Map<java.lang.String,java.lang.String> loadEnvironmentDefinitions()

clear

public void clear()

isDefined

public boolean isDefined(java.lang.String def)

Returns:

True if there is a definition having name def, regardless of its value.

getValue

public java.lang.String getValue(java.lang.String def)

define

public java.lang.String define(java.lang.String def)

Define def in the source file's local definition space.

define

public java.lang.String define(java.lang.String def,
                               java.lang.String value)

Define def in the source file's local definition space with value.

undef

public java.lang.String undef(java.lang.String def)

Remove def from the File's local definition space. Note if def is defined in a parent scope e.g., a properties file, it remains defined. In other words #undef applies exclusively to the source file scope.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object