JavaProject (JKube Kit :: Common 1.5.1 API)

java.lang.Object
- org.eclipse.jkube.kit.common.JavaProject

All Implemented Interfaces:

Serializable
```
public class JavaProject
extends Object
implements Serializable
```
Model class that represents a Java Project to be processed by JKube

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JavaProject.JavaProjectBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`JavaProject.JavaProjectBuilder`

Constructor Summary

Constructors
Constructor and Description
JavaProject(String name, String groupId, String artifactId, String version, File outputDirectory, File baseDirectory, File buildDirectory, File buildPackageDirectory, Properties properties, List<String> compileClassPathElements, List<Dependency> dependencies, List<Dependency> dependenciesWithTransitive, List<Plugin> plugins, String site, String description, String organizationName, String documentationUrl, String buildFinalName, File artifact, File localRepositoryBaseDirectory, String packaging, String issueManagementSystem, String issueManagementUrl, String url, String scmUrl, String scmTag, List<Maintainer> maintainers)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static JavaProject.JavaProjectBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`File`	`getArtifact()` Generated Artifact File for the project
`String`	`getArtifactId()` Maven artifact ID
`File`	`getBaseDirectory()` Project's base directory
`File`	`getBuildDirectory()` Directory where all build files are located (e.g.
`String`	`getBuildFinalName()` Filename (excluding the extension, and with no path information) that the produced project artifact will be called.
`File`	`getBuildPackageDirectory()` Directory where build packages or artifacts (jar/war/ear) are output.
`List<String>`	`getCompileClassPathElements()` Project Classpath entries.
`List<Dependency>`	`getDependencies()` Direct dependencies for the project.
`List<Dependency>`	`getDependenciesWithTransitive()` All dependencies (including transitive) for the project
`String`	`getDescription()` Project's description.
`String`	`getDocumentationUrl()` URL to the project's documentation.
`String`	`getGroupId()` Maven group ID
`String`	`getIssueManagementSystem()` Name of the issue management system for the project (e.g.
`String`	`getIssueManagementUrl()` URL for the issue management system used by the project.
`File`	`getLocalRepositoryBaseDirectory()` Directory for the project's local repository.
`List<Maintainer>`	`getMaintainers()` List of Maintainers involved with the project.
`String`	`getName()` Project's name.
`String`	`getOrganizationName()` Full name of the project's organization.
`File`	`getOutputDirectory()` Directory where compiled application classes are located (e.g.
`String`	`getPackaging()` Project's packaging type.
`List<Plugin>`	`getPlugins()` List of plugins (e.g.
`Properties`	`getProperties()` Project configuration properties to be used in generators and enrichers
`String`	`getScmTag()` Tag of the project's current code.
`String`	`getScmUrl()` URL for the project's browsable SCM repository.
`String`	`getSite()` URL to the project's homepage.
`String`	`getUrl()` URL for website of the project.
`String`	`getVersion()` Maven version
`int`	`hashCode()`
`void`	`setArtifact(File artifact)` Generated Artifact File for the project
`void`	`setArtifactId(String artifactId)` Maven artifact ID
`void`	`setBaseDirectory(File baseDirectory)` Project's base directory
`void`	`setBuildDirectory(File buildDirectory)` Directory where all build files are located (e.g.
`void`	`setBuildFinalName(String buildFinalName)` Filename (excluding the extension, and with no path information) that the produced project artifact will be called.
`void`	`setBuildPackageDirectory(File buildPackageDirectory)` Directory where build packages or artifacts (jar/war/ear) are output.
`void`	`setCompileClassPathElements(List<String> compileClassPathElements)` Project Classpath entries.
`void`	`setDependencies(List<Dependency> dependencies)` Direct dependencies for the project.
`void`	`setDependenciesWithTransitive(List<Dependency> dependenciesWithTransitive)` All dependencies (including transitive) for the project
`void`	`setDescription(String description)` Project's description.
`void`	`setDocumentationUrl(String documentationUrl)` URL to the project's documentation.
`void`	`setGroupId(String groupId)` Maven group ID
`void`	`setIssueManagementSystem(String issueManagementSystem)` Name of the issue management system for the project (e.g.
`void`	`setIssueManagementUrl(String issueManagementUrl)` URL for the issue management system used by the project.
`void`	`setLocalRepositoryBaseDirectory(File localRepositoryBaseDirectory)` Directory for the project's local repository.
`void`	`setMaintainers(List<Maintainer> maintainers)` List of Maintainers involved with the project.
`void`	`setName(String name)` Project's name.
`void`	`setOrganizationName(String organizationName)` Full name of the project's organization.
`void`	`setOutputDirectory(File outputDirectory)` Directory where compiled application classes are located (e.g.
`void`	`setPackaging(String packaging)` Project's packaging type.
`void`	`setPlugins(List<Plugin> plugins)` List of plugins (e.g.
`void`	`setProperties(Properties properties)` Project configuration properties to be used in generators and enrichers
`void`	`setScmTag(String scmTag)` Tag of the project's current code.
`void`	`setScmUrl(String scmUrl)` URL for the project's browsable SCM repository.
`void`	`setSite(String site)` URL to the project's homepage.
`void`	`setUrl(String url)` URL for website of the project.
`void`	`setVersion(String version)` Maven version

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JavaProject
```
public JavaProject(String name,
                   String groupId,
                   String artifactId,
                   String version,
                   File outputDirectory,
                   File baseDirectory,
                   File buildDirectory,
                   File buildPackageDirectory,
                   Properties properties,
                   List<String> compileClassPathElements,
                   List<Dependency> dependencies,
                   List<Dependency> dependenciesWithTransitive,
                   List<Plugin> plugins,
                   String site,
                   String description,
                   String organizationName,
                   String documentationUrl,
                   String buildFinalName,
                   File artifact,
                   File localRepositoryBaseDirectory,
                   String packaging,
                   String issueManagementSystem,
                   String issueManagementUrl,
                   String url,
                   String scmUrl,
                   String scmTag,
                   List<Maintainer> maintainers)
```
- Method Detail
  - builder
```
public static JavaProject.JavaProjectBuilder builder()
```
  - getName
```
public String getName()
```
    Project's name.
    
    Returns:
    
    The name of the project.
  - getGroupId
```
public String getGroupId()
```
    Maven group ID
    
    Returns:
    
    The maven group ID for the project.
  - getArtifactId
```
public String getArtifactId()
```
    Maven artifact ID
    
    Returns:
    
    The maven artifact ID for the project.
  - getVersion
```
public String getVersion()
```
    Maven version
    
    Returns:
    
    The maven version for the project.
  - getOutputDirectory
```
public File getOutputDirectory()
```
    Directory where compiled application classes are located (e.g. target/classes).
    
    Returns:
    
    The output directory for the project.
  - getBaseDirectory
```
public File getBaseDirectory()
```
    Project's base directory
    
    Returns:
    
    The base directory for the project.
  - getBuildDirectory
```
public File getBuildDirectory()
```
    Directory where all build files are located (e.g. target)
    
    Returns:
    
    The build directory for the project.
  - getBuildPackageDirectory
```
public File getBuildPackageDirectory()
```
    Directory where build packages or artifacts (jar/war/ear) are output. This can be target in case of Maven and build/libs in case of Gradle.
    This directory is used by generators and other build related tools to locate the files and packages to be included in the Container Image.
    Please note that it's different from buildDirectory or outputDirectory which may point to directory used by build tool or generated classes.
    
    Returns:
    
    the directory where the project artifacts and packages are output
  - getProperties
```
public Properties getProperties()
```
    Project configuration properties to be used in generators and enrichers
    
    Returns:
    
    The properties for the project.
  - getCompileClassPathElements
```
public List<String> getCompileClassPathElements()
```
    Project Classpath entries.
    
    Returns:
    
    The project's compile classpath elements.
  - getDependencies
```
public List<Dependency> getDependencies()
```
    Direct dependencies for the project.
    
    Returns:
    
    The project's direct dependency list.
  - getDependenciesWithTransitive
```
public List<Dependency> getDependenciesWithTransitive()
```
    All dependencies (including transitive) for the project
    
    Returns:
    
    The project's dependency list.
  - getPlugins
```
public List<Plugin> getPlugins()
```
    List of plugins (e.g. Maven plugins) for the project.
    
    Returns:
    
    The project's plugins.
  - getSite
```
public String getSite()
```
    URL to the project's homepage.
    
    Returns:
    
    The project's homepage.
  - getDescription
```
public String getDescription()
```
    Project's description.
    
    Returns:
    
    The project's description.
  - getOrganizationName
```
public String getOrganizationName()
```
    Full name of the project's organization.
    
    Returns:
    
    The project's organization full name.
  - getDocumentationUrl
```
public String getDocumentationUrl()
```
    URL to the project's documentation.
    
    Returns:
    
    The project's documentation URL.
  - getBuildFinalName
```
public String getBuildFinalName()
```
    Filename (excluding the extension, and with no path information) that the produced project artifact will be called.
    (e.g. The default value for Maven is ${artifactId}-${version}).
    
    Returns:
    
    The project's produced artifact filename.
  - getArtifact
```
public File getArtifact()
```
    Generated Artifact File for the project
    
    Returns:
    
    The project's generated artifact file.
  - getLocalRepositoryBaseDirectory
```
public File getLocalRepositoryBaseDirectory()
```
    Directory for the project's local repository.
    
    Returns:
    
    The project's local repository directory.
  - getPackaging
```
public String getPackaging()
```
    Project's packaging type. Specifies the type of artifact the project produces.
    (e.g. war, jar, ear...)
    
    Returns:
    
    The project's packaging type.
  - getIssueManagementSystem
```
public String getIssueManagementSystem()
```
    Name of the issue management system for the project (e.g. Bugzilla).
    
    Returns:
    
    The project's issue management system.
  - getIssueManagementUrl
```
public String getIssueManagementUrl()
```
    URL for the issue management system used by the project.
    
    Returns:
    
    The project's issue management URL.
  - getUrl
```
public String getUrl()
```
    URL for website of the project.
    
    Returns:
    
    The project's website URL.
  - getScmUrl
```
public String getScmUrl()
```
    URL for the project's browsable SCM repository.
    
    Returns:
    
    The project's SCM URL.
  - getScmTag
```
public String getScmTag()
```
    Tag of the project's current code.
    
    Returns:
    
    The project's SCM tag.
  - getMaintainers
```
public List<Maintainer> getMaintainers()
```
    List of Maintainers involved with the project.
    
    Returns:
    
    The project maintainers.
  - setName
```
public void setName(String name)
```
    Project's name.
    
    Parameters:
    
    name - New name for the project.
  - setGroupId
```
public void setGroupId(String groupId)
```
    Maven group ID
    
    Parameters:
    
    groupId - New maven group ID for the project.
  - setArtifactId
```
public void setArtifactId(String artifactId)
```
    Maven artifact ID
    
    Parameters:
    
    artifactId - New maven artifact ID for the project.
  - setVersion
```
public void setVersion(String version)
```
    Maven version
    
    Parameters:
    
    version - New maven version for the project.
  - setOutputDirectory
```
public void setOutputDirectory(File outputDirectory)
```
    Directory where compiled application classes are located (e.g. target/classes).
    
    Parameters:
    
    outputDirectory - New output directory for the project.
  - setBaseDirectory
```
public void setBaseDirectory(File baseDirectory)
```
    Project's base directory
    
    Parameters:
    
    baseDirectory - New base directory for the project.
  - setBuildDirectory
```
public void setBuildDirectory(File buildDirectory)
```
    Directory where all build files are located (e.g. target)
    
    Parameters:
    
    buildDirectory - New build directory for the project.
  - setBuildPackageDirectory
```
public void setBuildPackageDirectory(File buildPackageDirectory)
```
    Directory where build packages or artifacts (jar/war/ear) are output. This can be target in case of Maven and build/libs in case of Gradle.
    This directory is used by generators and other build related tools to locate the files and packages to be included in the Container Image.
    Please note that it's different from buildDirectory or outputDirectory which may point to directory used by build tool or generated classes.
    
    Parameters:
    
    buildPackageDirectory - directory where the project artifacts and packages are output
  - setProperties
```
public void setProperties(Properties properties)
```
    Project configuration properties to be used in generators and enrichers
    
    Parameters:
    
    properties - New configuration properties for the project.
  - setCompileClassPathElements
```
public void setCompileClassPathElements(List<String> compileClassPathElements)
```
    Project Classpath entries.
    
    Parameters:
    
    compileClassPathElements - New classpath entries for the project.
  - setDependencies
```
public void setDependencies(List<Dependency> dependencies)
```
    Direct dependencies for the project.
    
    Parameters:
    
    dependencies - New direct dependencies for the project.
  - setDependenciesWithTransitive
```
public void setDependenciesWithTransitive(List<Dependency> dependenciesWithTransitive)
```
    All dependencies (including transitive) for the project
    
    Parameters:
    
    dependenciesWithTransitive - New dependencies for the project.
  - setPlugins
```
public void setPlugins(List<Plugin> plugins)
```
    List of plugins (e.g. Maven plugins) for the project.
    
    Parameters:
    
    plugins - New plugins for the project.
  - setSite
```
public void setSite(String site)
```
    URL to the project's homepage.
    
    Parameters:
    
    site - New homepage for the project.
  - setDescription
```
public void setDescription(String description)
```
    Project's description.
    
    Parameters:
    
    description - New description for the project.
  - setOrganizationName
```
public void setOrganizationName(String organizationName)
```
    Full name of the project's organization.
    
    Parameters:
    
    organizationName - New organization name for the project.
  - setDocumentationUrl
```
public void setDocumentationUrl(String documentationUrl)
```
    URL to the project's documentation.
    
    Parameters:
    
    documentationUrl - New documentation URL for the project.
  - setBuildFinalName
```
public void setBuildFinalName(String buildFinalName)
```
    Filename (excluding the extension, and with no path information) that the produced project artifact will be called.
    (e.g. The default value for Maven is ${artifactId}-${version}).
    
    Parameters:
    
    buildFinalName - New filename for the project's produced artifact.
  - setArtifact
```
public void setArtifact(File artifact)
```
    Generated Artifact File for the project
    
    Parameters:
    
    artifact - New project's generated artifact file.
  - setLocalRepositoryBaseDirectory
```
public void setLocalRepositoryBaseDirectory(File localRepositoryBaseDirectory)
```
    Directory for the project's local repository.
    
    Parameters:
    
    localRepositoryBaseDirectory - New directory for the project's local repository.
  - setPackaging
```
public void setPackaging(String packaging)
```
    Project's packaging type. Specifies the type of artifact the project produces.
    (e.g. war, jar, ear...)
    
    Parameters:
    
    packaging - New packaging type for the project.
  - setIssueManagementSystem
```
public void setIssueManagementSystem(String issueManagementSystem)
```
    Name of the issue management system for the project (e.g. Bugzilla).
    
    Parameters:
    
    issueManagementSystem - New issue management system for the project.
  - setIssueManagementUrl
```
public void setIssueManagementUrl(String issueManagementUrl)
```
    URL for the issue management system used by the project.
    
    Parameters:
    
    issueManagementUrl - New issue management URL for the project.
  - setUrl
```
public void setUrl(String url)
```
    URL for website of the project.
    
    Parameters:
    
    url - URL for website of project.
  - setScmUrl
```
public void setScmUrl(String scmUrl)
```
    URL for the project's browsable SCM repository.
    
    Parameters:
    
    scmUrl - New SCM URL for the project.
  - setScmTag
```
public void setScmTag(String scmTag)
```
    Tag of the project's current code.
    
    Parameters:
    
    scmTag - New SCM tag for the project.
  - setMaintainers
```
public void setMaintainers(List<Maintainer> maintainers)
```
    List of Maintainers involved with the project.
    
    Parameters:
    
    maintainers - New maintainers for the project.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class JavaProject

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JavaProject

Method Detail

builder

getName

getGroupId

getArtifactId

getVersion

getOutputDirectory

getBaseDirectory

getBuildDirectory

getBuildPackageDirectory

getProperties

getCompileClassPathElements

getDependencies

getDependenciesWithTransitive

getPlugins

getSite

getDescription

getOrganizationName

getDocumentationUrl

getBuildFinalName

getArtifact

getLocalRepositoryBaseDirectory

getPackaging

getIssueManagementSystem

getIssueManagementUrl

getUrl

getScmUrl

getScmTag

getMaintainers

setName

setGroupId

setArtifactId

setVersion

setOutputDirectory

setBaseDirectory

setBuildDirectory

setBuildPackageDirectory

setProperties

setCompileClassPathElements

setDependencies

setDependenciesWithTransitive

setPlugins

setSite

setDescription

setOrganizationName

setDocumentationUrl

setBuildFinalName

setArtifact

setLocalRepositoryBaseDirectory

setPackaging

setIssueManagementSystem

setIssueManagementUrl

setUrl

setScmUrl

setScmTag

setMaintainers

equals

canEqual

hashCode