Interface ProjectDescription

All Known Implementing Classes:
MutableProjectDescription
public interface ProjectDescription
Description of a project to generate.
Author:
Andy Wilkinson, Stephane Nicoll

  • Method Details

    • createCopy

      default ProjectDescription 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 requested dependencies.
      Returns:
      the requested dependencies

    • getPlatformVersion

      @Nullable Version getPlatformVersion()
      Return the requested platform Version.
      Returns:
      the requested platform version or null

    • getBuildSystem

      @Nullable BuildSystem getBuildSystem()
      Return the BuildSystem to use.
      Returns:
      the build system or null

    • getPackaging

      @Nullable Packaging getPackaging()
      Return the build Packaging to use.
      Returns:
      the build packaging or null

    • getLanguage

      @Nullable Language getLanguage()
      Return the primary Language of the project.
      Returns:
      the primary language or null

    • getConfigurationFileFormat

      @Nullable ConfigurationFileFormat getConfigurationFileFormat()
      Return the ConfigurationFileFormat of the project.
      Returns:
      the configuration file format or null

    • getGroupId

      @Nullable String getGroupId()
      Return the build groupId.
      Returns:
      the groupId or null

    • getArtifactId

      @Nullable String getArtifactId()
      Return the build artifactId.
      Returns:
      the artifactId or null

    • getVersion

      @Nullable String getVersion()
      Return the version of the project.
      Returns:
      the version of null

    • getName

      @Nullable String getName()
      Return a simple name for the project.
      Returns:
      the name of the project or null

    • getDescription

      @Nullable String getDescription()
      Return a human-readable description of the project.
      Returns:
      the description of the project or null

    • getApplicationName

      @Nullable String getApplicationName()
      Return the name of the application as a standard Java identifier.
      Returns:
      the name of the application or null

    • getPackageName

      @Nullable String getPackageName()
      Return the root package name of the project.
      Returns:
      the package name or null

    • getBaseDirectory

      @Nullable String getBaseDirectory()
      Return the base directory of the project or null to use the root directory.
      Returns:
      the base directory