org.apache.felix.scrplugin

Class Options

java.lang.Object

org.apache.felix.scrplugin.Options

public class Options
extends java.lang.Object

Options for the SCRDescriptorGenerator

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	generateAccessors Flag for generating accessor methods.
private boolean	incremental Is this an incremental build?
private java.io.File	outputDirectory The output directory for the generated files.
private static java.lang.String	PARENT_NAME
private java.util.Map<java.lang.String,java.lang.String>	properties Map of global properties.
private boolean	skipVolatileCheck Skip volatile check.
private SpecVersion	specVersion The requested spec version.
private boolean	strictMode Flag for strict mode.

Constructor Summary

Constructors

Constructor and Description
Options()

Method Summary

Modifier and Type	Method and Description
java.io.File	getComponentDescriptorDirectory() Convenience method to get the component descriptor directory.
java.io.File	getMetaTypeDirectory() Convenience method to get the meta type directory.
java.io.File	getOutputDirectory()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
SpecVersion	getSpecVersion()
boolean	isGenerateAccessors()
boolean	isIncremental() Is this an incremental build
boolean	isSkipVolatileCheck() Should the check for volatile fields be skipped?
boolean	isStrictMode()
void	setGenerateAccessors(boolean generateAccessors) Defines whether bind and unbind methods are automatically created by the SCR descriptor generator.
void	setIncremental(boolean incremental) Set whether this is an incremental build
void	setOutputDirectory(java.io.File outputDirectory) Sets the directory where the descriptor files will be created.
void	setProperties(java.util.Map<java.lang.String,java.lang.String> properties) Sets global properties to be set for each descriptor.
void	setSkipVolatileCheck(boolean skipVolatileCheck) Set whether the check should be skipped
void	setSpecVersion(SpecVersion specVersion) Sets the Declarative Services specification version number to be forced on the declarations.
void	setStrictMode(boolean strictMode) Defines whether warnings should be considered as errors and thus cause the generation process to fail.

Methods inherited from class java.lang.Object

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

Field Detail

generateAccessors

private boolean generateAccessors

Flag for generating accessor methods.

strictMode

private boolean strictMode

Flag for strict mode.

properties

private java.util.Map<java.lang.String,java.lang.String> properties

Map of global properties.

specVersion

private SpecVersion specVersion

The requested spec version.

outputDirectory

private java.io.File outputDirectory

The output directory for the generated files.

incremental

private boolean incremental

Is this an incremental build?

skipVolatileCheck

private boolean skipVolatileCheck

Skip volatile check.

PARENT_NAME

private static final java.lang.String PARENT_NAME

See Also:

Constant Field Values

Constructor Detail

Options

public Options()

Method Detail

isGenerateAccessors

public boolean isGenerateAccessors()

Returns:

Whether accessor methods should be generated.

See Also:

setGenerateAccessors(boolean)

setGenerateAccessors

public void setGenerateAccessors(boolean generateAccessors)

Defines whether bind and unbind methods are automatically created by the SCR descriptor generator.

The generator uses the ASM library to create the method byte codes directly inside the class files. If bind and unbind methods are not to be created, the generator fails if such methods are missing.

The default value of this property is true.

isStrictMode

public boolean isStrictMode()

Returns:

Whether strict mode should be used or not.

See Also:

setStrictMode(boolean)

setStrictMode

public void setStrictMode(boolean strictMode)

Defines whether warnings should be considered as errors and thus cause the generation process to fail.

The default value of this property is false.

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Sets global properties to be set for each descriptor. If a descriptor provides properties of the same name, the descriptor properties are preferred over the properties provided here.

The are no default global properties.

getSpecVersion

public SpecVersion getSpecVersion()

Returns:

Return the requested spec version

See Also:

setSpecVersion(SpecVersion)

setSpecVersion

public void setSpecVersion(SpecVersion specVersion)

Sets the Declarative Services specification version number to be forced on the declarations.

Supported values for this property are null to autodetect the specification version, or one of the enum values from SpecVersion.

The default is to generate the descriptor version according to the capabilities used by the descriptors. If no 1.1 capabilities, such as configuration-policy, are used, version 1.0 is used, otherwise a 1.1 descriptor is generated.

getOutputDirectory

public java.io.File getOutputDirectory()

Returns:

The output directory for the generated files.

See Also:

setOutputDirectory(File)

setOutputDirectory

public void setOutputDirectory(java.io.File outputDirectory)

Sets the directory where the descriptor files will be created.

This field has no default value and this setter must called before passing this object to SCRDescriptorGenerator.setOptions(Options).

getMetaTypeDirectory

public java.io.File getMetaTypeDirectory()

Convenience method to get the meta type directory.

getComponentDescriptorDirectory

public java.io.File getComponentDescriptorDirectory()

Convenience method to get the component descriptor directory.

isIncremental

public boolean isIncremental()

Is this an incremental build

setIncremental

public void setIncremental(boolean incremental)

Set whether this is an incremental build

isSkipVolatileCheck

public boolean isSkipVolatileCheck()

Should the check for volatile fields be skipped?

setSkipVolatileCheck

public void setSkipVolatileCheck(boolean skipVolatileCheck)

Set whether the check should be skipped