Interface ProjectDescription
- All Known Implementing Classes:
MutableProjectDescription
public interface ProjectDescription
Description of a project to generate.
- Author:
- Andy Wilkinson, Stephane Nicoll
-
Method Summary
Modifier and TypeMethodDescriptiondefault ProjectDescriptionCreate a full copy of this description so that any additional changes made on this instance are not reflected on the returned copy.Return the name of the application as a standard Java identifier.Return the buildartifactId.Return the base directory of the project ornullto use the root directory.Return theBuildSystemto use.Return a human-readable description of the project.Return the buildgroupId.Return the primaryLanguageof the project.getName()Return a simple name for the project.Return the root package name of the project.Return the buildPackagingto use.Return the requested platformVersion.Return an immutable mapping of requesteddependencies.Return the version of the project.
-
Method Details
-
createCopy
Create a full copy of this description so that any additional changes made on this instance are not reflected on the returned copy.- Returns:
- a clone of this instance
-
getRequestedDependencies
Map<String,Dependency> getRequestedDependencies()Return an immutable mapping of requesteddependencies.- Returns:
- the requested dependencies
-
getPlatformVersion
Version getPlatformVersion()Return the requested platformVersion.- Returns:
- the requested platform version or
null
-
getBuildSystem
BuildSystem getBuildSystem()Return theBuildSystemto use.- Returns:
- the build system or
null
-
getPackaging
Packaging getPackaging()Return the buildPackagingto use.- Returns:
- the build packaging or
null
-
getLanguage
Language getLanguage()Return the primaryLanguageof the project.- Returns:
- the primary language or
null
-
getGroupId
String getGroupId()Return the buildgroupId.- Returns:
- the groupId or
null
-
getArtifactId
String getArtifactId()Return the buildartifactId.- Returns:
- the artifactId or
null
-
getVersion
String getVersion()Return the version of the project.- Returns:
- the version of
null
-
getName
String getName()Return a simple name for the project.- Returns:
- the name of the project or
null
-
getDescription
String getDescription()Return a human-readable description of the project.- Returns:
- the description of the project or
null
-
getApplicationName
String getApplicationName()Return the name of the application as a standard Java identifier.- Returns:
- the name of the application or
null
-
getPackageName
String getPackageName()Return the root package name of the project.- Returns:
- the package name or
null
-
getBaseDirectory
String getBaseDirectory()Return the base directory of the project ornullto use the root directory.- Returns:
- the base directory
-