io.dekorate.project

Class BuildInfo

java.lang.Object

io.dekorate.project.BuildInfo

Direct Known Subclasses:

EditableBuildInfo

public class BuildInfo
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BUILD_TOOL
static String	DEFAULT_PACKAGING

Constructor Summary

Constructors

Constructor and Description
BuildInfo()
BuildInfo(String name, String version, String packaging, String buildTool, String buildToolVersion, Path outputFile, Path classOutputDir, Path resourceDir) Constructor

Method Summary

Modifier and Type	Method and Description
BuildInfoBuilder	edit()
String	getBuildTool() Get the build tool name.
String	getBuildToolVersion()
Path	getClassOutputDir()
String	getName() Get the project name.
Path	getOutputFile() Get the output file name.
String	getPackaging() Get the project packaging.
Path	getResourceDir()
String	getVersion() Get the project version.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PACKAGING

public static String DEFAULT_PACKAGING

DEFAULT_BUILD_TOOL

public static String DEFAULT_BUILD_TOOL

Constructor Detail

BuildInfo

public BuildInfo()

BuildInfo

public BuildInfo(String name,
                 String version,
                 String packaging,
                 String buildTool,
                 String buildToolVersion,
                 Path outputFile,
                 Path classOutputDir,
                 Path resourceDir)

Constructor

Parameters:

name - The project name (e.g. maven artifactId).

version - The project version (e.g. maven version).

packaging - The project packaging (e.g. jar, war).

buildTool - The project build tool (e.g. maven, gralde, sbt)

buildToolVersion - The build tool version

outputFile - The output file (the path to the actual jar, war etc).

classOutputDir - The resource output directory (e.g. target/classes, build/classes/main/java etc).

resourceDir - The directory from which application resources should be read. (e.g. target/classes for maven, src/main/resources from gralde and so on).

Method Detail

edit

public BuildInfoBuilder edit()

getName

public String getName()

Get the project name.

Returns:

The project name.

getVersion

public String getVersion()

Get the project version.

Returns:

The project version.

getPackaging

public String getPackaging()

Get the project packaging.

Returns:

The project packaging.

getBuildTool

public String getBuildTool()

Get the build tool name.

Returns:

the name of the build tool.

getBuildToolVersion

public String getBuildToolVersion()

getOutputFile

public Path getOutputFile()

Get the output file name.

Returns:

The output file name.

getClassOutputDir

public Path getClassOutputDir()

getResourceDir

public Path getResourceDir()