com.oracle.bedrock.maven

Class Maven

java.lang.Object

com.oracle.bedrock.maven.Maven

All Implemented Interfaces:

com.oracle.bedrock.ComposableOption<Maven>, com.oracle.bedrock.Option, Profile

public class Maven
extends Object
implements Profile, com.oracle.bedrock.ComposableOption<Maven>

The Maven Profile provides the ability define a Maven environment, configuration, together with zero or more Artifacts to be resolved to automatically construct a ClassPath for a JavaApplication.

Maven Profiles are ComposableOptions. When multiple are provided as a parameter, they will be composed in order of declaration into a single new instance.

Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Brian Oliver

Nested Class Summary

Nested classes/interfaces inherited from interface com.oracle.bedrock.Option

com.oracle.bedrock.Option.Collectable, com.oracle.bedrock.Option.Collector<C extends com.oracle.bedrock.Option.Collectable,T extends com.oracle.bedrock.Option.Collector<C,T>>

Method Summary

Modifier and Type	Method and Description
static Maven	artifact(String artifact) Create a Maven Profile consisting of the specified Artifact, parsed from the String in the following format: <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>.
static Maven	artifact(String groupId, String artifactId, String version) Create a Maven Profile consisting of the artifact specified groupId, artifactId and version (using the default extension .jar and no classifier)
static Maven	autoDetect() Obtains a Maven Profile, automatically detecting the configuration from the underlying environment, without any Artifacts defined, and being online by default.
Maven	compose(Maven other)
boolean	equals(Object o)
int	hashCode()
static Maven	include(ClassPath classPath) Create a default Maven Profile that includes the specified ClassPath, that is included after any resolved Maven artifacts.
static Maven	offline() Create a default Maven Profile that is offline.
static Maven	offline(boolean isOffline) Create a default Maven Profile using the specified offline status
void	onClosing(Platform platform, Application application, com.oracle.bedrock.OptionsByType optionsByType)
void	onLaunched(Platform platform, Application application, com.oracle.bedrock.OptionsByType optionsByType)
void	onLaunching(Platform platform, MetaClass metaClass, com.oracle.bedrock.OptionsByType optionsByType)
static Maven	scope(String scope) Create a default Maven Profile and use the specified scope when resolving artifacts.
static Maven	settings(File settingsFileLocation) Create a default Maven Profile and use the specified user settings.xml location.
static Maven	settings(String settingsFileLocation) Create a default Maven Profile and use the specified user settings.xml location.

Methods inherited from class java.lang.Object

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

Method Detail

onLaunching

public void onLaunching(Platform platform,
                        MetaClass metaClass,
                        com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

onLaunching in interface Profile

onLaunched

public void onLaunched(Platform platform,
                       Application application,
                       com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

onLaunched in interface Profile

onClosing

public void onClosing(Platform platform,
                      Application application,
                      com.oracle.bedrock.OptionsByType optionsByType)

Specified by:

onClosing in interface Profile

artifact

public static Maven artifact(String artifact)

Create a Maven Profile consisting of the specified Artifact, parsed from the String in the following format: <groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>.

Parameters:

artifact - the g:a[:e][:c]:v coordinates of the Artifact

Returns:

a new Maven Profile

artifact

public static Maven artifact(String groupId,
                             String artifactId,
                             String version)

Create a Maven Profile consisting of the artifact specified groupId, artifactId and version (using the default extension .jar and no classifier)

Parameters:

groupId - the group id

artifactId - the artifact id

version - the version

Returns:

a new Maven Profile

offline

public static Maven offline()

Create a default Maven Profile that is offline.

Returns:

an offline Maven Profile

offline

public static Maven offline(boolean isOffline)

Create a default Maven Profile using the specified offline status

Parameters:

isOffline - true if the Maven Profile should be offline, false otherwise

Returns:

a Maven Profile with the specified offline status

settings

public static Maven settings(String settingsFileLocation)

Create a default Maven Profile and use the specified user settings.xml location.

Parameters:

settingsFileLocation - the location of the Maven settings.xml file, or null to use the default/auto-detect

Returns:

a Maven Profile with the specified user settings file

settings

public static Maven settings(File settingsFileLocation)

Create a default Maven Profile and use the specified user settings.xml location.

Parameters:

settingsFileLocation - the location of the Maven settings.xml file, or null to use the default/auto-detect

Returns:

a Maven Profile with the specified user settings file

scope

public static Maven scope(String scope)

Create a default Maven Profile and use the specified scope when resolving artifacts.

Parameters:

scope - the Maven Scope for artifact resolution, or null to use the default (which is RUNTIME)

Returns:

a Maven Profile with the specified scope

See Also:

JavaScopes

include

public static Maven include(ClassPath classPath)

Create a default Maven Profile that includes the specified ClassPath, that is included after any resolved Maven artifacts.

Parameters:

classPath - the additional ClassPath

Returns:

a Maven Profile with the additional ClassPath

autoDetect

@OptionsByType.Default
public static Maven autoDetect()

Obtains a Maven Profile, automatically detecting the configuration from the underlying environment, without any Artifacts defined, and being online by default.

Returns:

a Maven Profile

compose

public Maven compose(Maven other)

Specified by:

compose in interface com.oracle.bedrock.ComposableOption<Maven>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object