Package com.qulice.maven

Class DefaultMavenEnvironment

java.lang.Object

com.qulice.maven.DefaultMavenEnvironment

All Implemented Interfaces:

Environment

public final class DefaultMavenEnvironment
extends Object

Environment, passed from MOJO to validators.

Since:

0.3

Suppressed Checkstyle violations:

ClassDataAbstractionCouplingCheck (300 lines)

Nested Class Summary

Nested classes/interfaces inherited from interface com.qulice.spi.Environment

Environment.Mock

Constructor Summary

Constructors

Constructor	Description
DefaultMavenEnvironment()

Method Summary

Modifier and Type	Method	Description
Collection<String>	asserts()
File	basedir()
ClassLoader	classloader()
Collection<String>	classpath()
Properties	config()
org.codehaus.plexus.context.Context	context()
Charset	encoding()	Get source files encoding.
boolean	exclude(String check, String name)
Collection<String>	excludes(String checker)
MojoExecutor	executor()
Collection<File>	files(String pattern)
File	outdir()
String	param(String name, String value)
org.apache.maven.project.MavenProject	project()
Properties	properties()
void	setAsser(Collection<String> ass)	Set list of Xpath queries for pom.xml validation.
void	setContext(org.codehaus.plexus.context.Context ctx)	Set context.
void	setEncoding(String encoding)
void	setExcludes(Collection<String> exprs)	Set list of regular expressions to exclude.
void	setMojoExecutor(MojoExecutor exec)	Set executor.
void	setProject(org.apache.maven.project.MavenProject proj)	Set Maven Project (used mostly for unit testing).
void	setProperty(String name, String value)	Set property.
File	tempdir()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMavenEnvironment

public DefaultMavenEnvironment()

Method Detail

param

public String param(String name,
                    String value)

Specified by:

param in interface Environment

basedir

public File basedir()

Specified by:

basedir in interface Environment

tempdir

public File tempdir()

Specified by:

tempdir in interface Environment

outdir

public File outdir()

Specified by:

outdir in interface Environment

classpath

public Collection<String> classpath()

Specified by:

classpath in interface Environment

classloader

public ClassLoader classloader()

Specified by:

classloader in interface Environment

project

public org.apache.maven.project.MavenProject project()

properties

public Properties properties()

context

public org.codehaus.plexus.context.Context context()

config

public Properties config()

executor

public MojoExecutor executor()

asserts

public Collection<String> asserts()

files

public Collection<File> files(String pattern)

Specified by:

files in interface Environment

exclude

public boolean exclude(String check,
                       String name)

Specified by:

exclude in interface Environment

excludes

public Collection<String> excludes(String checker)

Specified by:

excludes in interface Environment

setProject

public void setProject(org.apache.maven.project.MavenProject proj)

Set Maven Project (used mostly for unit testing).

Parameters:

proj - The project to set

setContext

public void setContext(org.codehaus.plexus.context.Context ctx)

Set context.

Parameters:

ctx - The context to set

setMojoExecutor

public void setMojoExecutor(MojoExecutor exec)

Set executor.

Parameters:

exec - The executor

setProperty

public void setProperty(String name,
                        String value)

Set property.

Parameters:

name - Its name

value - Its value

setExcludes

public void setExcludes(Collection<String> exprs)

Set list of regular expressions to exclude.

Parameters:

exprs - Expressions

setAsser

public void setAsser(Collection<String> ass)

Set list of Xpath queries for pom.xml validation.

Parameters:

ass - Xpath queries

setEncoding

public void setEncoding(String encoding)

encoding

public Charset encoding()

Get source files encoding.

Specified by:

encoding in interface Environment

Returns:

Charset of the source files