org.jboss.forge.addon.projects.facets

Interface MetadataFacet

All Superinterfaces:

Facet<Project>, ProjectFacet, ProvidedProjectFacet

public interface MetadataFacet
extends ProvidedProjectFacet

Author:

Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getDirectProperties() Return a Map of all build properties defined directly in this Project.
String	getDirectProperty(String name) Get a build property by name.
Map<String,String>	getEffectiveProperties() Return a Map of all resolvable build properties in this Project and its parent hierarchy.
String	getEffectiveProperty(String name) Get a build property by name.
Dependency	getOutputDependency() Return a handle to the final output dependency of this Project.
String	getProjectGroupName() Get the project group name of this Project.
String	getProjectName() Get the name of this Project.
ProjectProvider	getProjectProvider() Return the ProjectProvider being used in the current Project.
String	getProjectVersion() Get the version of this Project.
String	getTopLevelPackage() Deprecated. use getProjectGroupName()
boolean	isValid() Returns true if the underlying Project metadata is in a valid state.
String	removeDirectProperty(String name) Remove a build property by name.
MetadataFacet	setDirectProperty(String name, String value) Set a build dependency property in the current project.
MetadataFacet	setProjectGroupName(String groupId) Set the top level package of this Project.
MetadataFacet	setProjectName(String name) Set the name of this Project.
MetadataFacet	setProjectVersion(String version) Set the version of this Project.
MetadataFacet	setTopLevelPackage(String groupId) Deprecated. use setProjectGroupName(String)

Methods inherited from interface org.jboss.forge.addon.facets.Facet

getFaceted, install, isInstalled, uninstall

Method Detail

getProjectName

String getProjectName()

Get the name of this Project.

setProjectName

MetadataFacet setProjectName(String name)

Set the name of this Project.

getTopLevelPackage

@Deprecated
String getTopLevelPackage()

Deprecated. use getProjectGroupName()

Get the top level package of this Project.

getProjectGroupName

String getProjectGroupName()

Get the project group name of this Project.

setTopLevelPackage

@Deprecated
MetadataFacet setTopLevelPackage(String groupId)

Deprecated. use setProjectGroupName(String)

Set the top level package of this Project.

setProjectGroupName

MetadataFacet setProjectGroupName(String groupId)

Set the top level package of this Project.

getProjectVersion

String getProjectVersion()

Get the version of this Project.

setProjectVersion

MetadataFacet setProjectVersion(String version)

Set the version of this Project.

getOutputDependency

Dependency getOutputDependency()

Return a handle to the final output dependency of this Project.

NOTE: Project may need to be built via PackagingFacet.executeBuild(String...) or PackagingFacet.createBuilder() before this method will successfully return a result.

getEffectiveProperties

Map<String,String> getEffectiveProperties()

Return a Map of all resolvable build properties in this Project and its parent hierarchy.

Properties can be used anywhere in a Project configuration and its dependencies, and will be expanded during building to the resolved property value.

getDirectProperties

Map<String,String> getDirectProperties()

Return a Map of all build properties defined directly in this Project.

Properties can be used anywhere in a Project configuration and its dependencies, and will be expanded during building to the resolved property value.

getEffectiveProperty

String getEffectiveProperty(String name)

Get a build property by name. Returns null if no such property exists in the Project and its parent hierarchy.

Properties can be used anywhere in a Project configuration and its dependencies, and will be expanded during building to the resolved property value.

getDirectProperty

String getDirectProperty(String name)

Get a build property by name. Returns null if no such property is defined directly in this project.

Properties can be used anywhere in a Project configuration and its dependencies, and will be expanded during building to the resolved property value.

setDirectProperty

MetadataFacet setDirectProperty(String name,
                              String value)

Set a build dependency property in the current project. This overrides any existing or inherited properties.

Properties can be used anywhere in a Project configuration and its dependencies, and will be expanded during building to the resolved property value.

removeDirectProperty

String removeDirectProperty(String name)

Remove a build property by name. (Build properties, such as ${my.version}, can be used anywhere in a dependency, and will be expanded during building to their property value.)

getProjectProvider

ProjectProvider getProjectProvider()

Return the ProjectProvider being used in the current Project.

isValid

boolean isValid()

Returns true if the underlying Project metadata is in a valid state.