io.micronaut.cli.profile

Interface Profile

public interface Profile

A Profile defines an active code generation and command execution policy. For example the "web" profile allows the execution of code gen and build commands that relate to web applications

Since:

1.0

Author:

Graeme Rocher, Lari Hotari

Method Summary

Modifier and Type	Method and Description
Set<String>	getBinaryExtensions()
List<String>	getBuildMergeProfileNames()
List<String>	getBuildPlugins()
List<String>	getBuildRepositories()
io.micronaut.cli.profile.Command	getCommand(io.micronaut.cli.profile.ProjectContext context, String name) Obtain a command by name.
Iterable<io.micronaut.cli.profile.Command>	getCommands(io.micronaut.cli.profile.ProjectContext context) The profile Command instances.
Iterable<jline.console.completer.Completer>	getCompleters(io.micronaut.cli.profile.ProjectContext context) The profile completers.
io.micronaut.cli.config.NavigableMap	getConfiguration()
Iterable<io.micronaut.cli.profile.Feature>	getDefaultFeatures()
List<org.eclipse.aether.graph.Dependency>	getDependencies()
String	getDescription()
Set<String>	getExecutablePatterns()
Iterable<Profile>	getExtends() The other Profile instances that this Profile extends.
Iterable<io.micronaut.cli.profile.Feature>	getFeatures()
String	getInstructions()
List<String>	getJvmArgs()
String	getName()
Iterable<io.micronaut.cli.profile.OneOfFeatureGroup>	getOneOfFeatures()
String	getParentSkeletonDir()
File	getParentSkeletonDir(File parent)
Resource	getProfileDir()
List<String>	getRepositories()
Iterable<io.micronaut.cli.profile.Feature>	getRequiredFeatures()
List<String>	getSkeletonExcludes()
Resource	getTemplate(String path) Obtain a template by path.
String	getVersion()
boolean	handleCommand(io.micronaut.cli.profile.ExecutionContext context) Obtains a Command.
boolean	hasCommand(io.micronaut.cli.profile.ProjectContext context, String name) Whether a command executes for the given context and name.
boolean	isAbstract()

Method Detail

getName

String getName()

Returns:

The name of the profile

getVersion

String getVersion()

Returns:

The version of the profile

getDescription

String getDescription()

Returns:

The description of the profile

getBinaryExtensions

Set<String> getBinaryExtensions()

Returns:

The list of file extensions which should be treated as binary

getExecutablePatterns

Set<String> getExecutablePatterns()

Returns:

The list of file patterns which should be executable in the resulting application

getInstructions

String getInstructions()

Returns:

Text to display after an application has been created with the profile

getFeatures

Iterable<io.micronaut.cli.profile.Feature> getFeatures()

Returns:

The features for this profile

getDefaultFeatures

Iterable<io.micronaut.cli.profile.Feature> getDefaultFeatures()

Returns:

The default features for this profile

getOneOfFeatures

Iterable<io.micronaut.cli.profile.OneOfFeatureGroup> getOneOfFeatures()

Returns:

The oneOf features for this profile

getRequiredFeatures

Iterable<io.micronaut.cli.profile.Feature> getRequiredFeatures()

Returns:

The required features for this profile

getExtends

Iterable<Profile> getExtends()

The other Profile instances that this Profile extends.

Returns:

zero or many Profile instance that this profile extends from

getRepositories

List<String> getRepositories()

Returns:

The maven repository definitions for this profile

getDependencies

List<org.eclipse.aether.graph.Dependency> getDependencies()

Returns:

The dependency definitions for this profile

getJvmArgs

List<String> getJvmArgs()

Returns:

The JVM args

getConfiguration

io.micronaut.cli.config.NavigableMap getConfiguration()

Returns:

The profiles configuration

getProfileDir

Resource getProfileDir()

Returns:

The directory where the profile is located locally

getTemplate

Resource getTemplate(String path)

Obtain a template by path.

Parameters:

path - The path to template

Returns:

The resource or null if it doesn't exist

getCommand

io.micronaut.cli.profile.Command getCommand(io.micronaut.cli.profile.ProjectContext context,
                                            String name)

Obtain a command by name.

Parameters:

context - The ProjectContext instance

name - Obtain a command by name

Returns:

The command

getCompleters

Iterable<jline.console.completer.Completer> getCompleters(io.micronaut.cli.profile.ProjectContext context)

The profile completers.

Parameters:

context - The ProjectContext instance

Returns:

An Iterable of Completer instances

getCommands

Iterable<io.micronaut.cli.profile.Command> getCommands(io.micronaut.cli.profile.ProjectContext context)

The profile Command instances.

Parameters:

context - The ProjectContext instance

Returns:

An Iterable of Command instances

hasCommand

boolean hasCommand(io.micronaut.cli.profile.ProjectContext context,
                   String name)

Whether a command executes for the given context and name.

Parameters:

context - The ProjectContext

name - The command name

Returns:

True if the command does exist

handleCommand

boolean handleCommand(io.micronaut.cli.profile.ExecutionContext context)

Obtains a Command.

Parameters:

context - The execution context

Returns:

True if the command was handled

getBuildRepositories

List<String> getBuildRepositories()

Returns:

The buildscript maven repository definitions for this profile

getBuildMergeProfileNames

List<String> getBuildMergeProfileNames()

Returns:

The profile names to participate in build merge

getBuildPlugins

List<String> getBuildPlugins()

Returns:

The list of build plugins for this profile

getParentSkeletonDir

String getParentSkeletonDir()

Returns:

The subfolder the parent profile(s) skeleton should be copied into

getParentSkeletonDir

File getParentSkeletonDir(File parent)

Parameters:

parent - The parent folder

Returns:

The directory the parent profile(s) skeleton should be copied into

getSkeletonExcludes

List<String> getSkeletonExcludes()

Returns:

A list of paths to exclude from the skeleton. Used in ant fileset exclude:

isAbstract

boolean isAbstract()

Returns:

True if the profile is not designed for direct use