org.eclipse.jkube.kit.enricher.api

Interface EnricherContext

All Known Implementing Classes:

JKubeEnricherContext

public interface EnricherContext

Method Summary

Modifier and Type	Method and Description
Configuration	getConfiguration() The configuration specific to the enricher.
List<org.eclipse.jkube.kit.common.Dependency>	getDependencies(boolean transitive) Gets dependencies defined in build tool
default Optional<String>	getDependencyVersion(String groupId, String artifactId) Gets version of given dependency.
GroupArtifactVersion	getGav() Get the current artifact with its parameters
HandlerHub	getHandlerHub() Returns the global Handler Hub to use with the enrichers.
org.eclipse.jkube.kit.common.KitLogger	getLog() Get Logger.
Map<String,String>	getProcessingInstructions()
org.eclipse.jkube.kit.common.JavaProject	getProject()
org.eclipse.jkube.kit.common.util.ProjectClassLoaders	getProjectClassLoaders() Get various class loaders used in the projects
File	getProjectDirectory() Base directory of the project.
Properties	getProperties() Returns the properties applicable for this EnricherContext.
String	getProperty(String key) Gets a property used in project.
default boolean	hasDependency(String groupId, String artifactId) Checks if given dependency is defined.
boolean	hasPlugin(String groupId, String artifactId) Check if a given plugin is present
void	setProcessingInstructions(Map<String,String> instructions)

Method Detail

getGav

GroupArtifactVersion getGav()

Get the current artifact with its parameters

Returns:

the artifact

getLog

org.eclipse.jkube.kit.common.KitLogger getLog()

Get Logger.

Returns:

Logger.

getConfiguration

Configuration getConfiguration()

The configuration specific to the enricher.

Returns:

configuration to use

getProcessingInstructions

Map<String,String> getProcessingInstructions()

setProcessingInstructions

void setProcessingInstructions(Map<String,String> instructions)

getProjectDirectory

File getProjectDirectory()

Base directory of the project. E.g. for Maven that's the directory where the pom.xml is placed in

Returns:

the projects based directory

getProjectClassLoaders

org.eclipse.jkube.kit.common.util.ProjectClassLoaders getProjectClassLoaders()

Get various class loaders used in the projects

Returns:

compile and test class loader

hasPlugin

boolean hasPlugin(String groupId,
                  String artifactId)

Check if a given plugin is present

Parameters:

groupId - group id of plugin to check. If null any group will be considered.

artifactId - of plugin to check

Returns:

true if a plugin exists, false otherwise.

getDependencies

List<org.eclipse.jkube.kit.common.Dependency> getDependencies(boolean transitive)

Gets dependencies defined in build tool

Parameters:

transitive - if transitive deps should be returned.

Returns:

List of dependencies.

hasDependency

default boolean hasDependency(String groupId,
                              String artifactId)

Checks if given dependency is defined.

Parameters:

groupId - of dependency.

artifactId - of dependency. If null, check if there is any dependency with the given group

Returns:

True if present, false otherwise.

getDependencyVersion

default Optional<String> getDependencyVersion(String groupId,
                                              String artifactId)

Gets version of given dependency.

Parameters:

groupId - of the dependency.

artifactId - of the dependency.

Returns:

Version number.

getProperties

Properties getProperties()

Returns the properties applicable for this EnricherContext.

Returns:

properties for the context

getProperty

String getProperty(String key)

Gets a property used in project.

Parameters:

key - name of property

Returns:

value of property if set.

getProject

org.eclipse.jkube.kit.common.JavaProject getProject()

getHandlerHub

HandlerHub getHandlerHub()

Returns the global Handler Hub to use with the enrichers.

Returns:

the Handler Hub instance.