com.asakusafw.utils.gradle

Class BaseProject<TSelf extends BaseProject<TSelf>>

java.lang.Object

com.asakusafw.utils.gradle.BaseProject<TSelf>

Type Parameters:

TSelf - this type

All Implemented Interfaces:

ProjectContext

Direct Known Subclasses:

BasicProject

public abstract class BaseProject<TSelf extends BaseProject<TSelf>>
extends Object
implements ProjectContext

An abstract implementation of project structure.

Since:

0.9.2

See Also:

BasicProject

Constructor Summary

Constructors

Constructor and Description
BaseProject()

Method Summary

Modifier and Type	Method and Description
protected <T> TSelf	configure(T object, TryConsumer<? super T,IOException> configurator) Configures the given object.
Map<String,String>	environment() Returns the environment variables.
String	environment(String name) Returns the environment variable.
protected Bundle	getBundle(Path path) Returns a project related bundle.
CommandLauncher	getCommandLauncher() Returns a command launcher of this context.
Bundle	getContents() Returns the project bundle.
protected abstract Path	getDirectory() Returns the project directory.
TSelf	gradle(String... tasks) Launches Gradle tasks.
TSelf	gradle(TryConsumer<? super GradleAdapter,IOException> configurator) Proceeds Gradle actions on this project.
Map<String,String>	properties() Returns the system properties.
String	property(String key) Returns the system property.
protected TSelf	self() Returns this object.
TSelf	with(Consumer<? super TSelf> configurator) Configures this project.
TSelf	withContents(TryConsumer<? super Bundle,IOException> configurator) Returns the project bundle.
TSelf	withEnvironment(Consumer<? super Map<String,String>> configurator) Sets the environment variables.
TSelf	withEnvironment(String name, String value) Puts an environment variable.
TSelf	withProperties(Consumer<? super Map<String,String>> configurator) Sets the system properties.
TSelf	withProperty(String name, String value) Puts an system property.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseProject

public BaseProject()

Method Detail

self

protected TSelf self()

Returns this object.

Returns:

this

environment

public Map<String,String> environment()

Description copied from interface: ProjectContext

Returns the environment variables.

Specified by:

environment in interface ProjectContext

Returns:

the environment variables

properties

public Map<String,String> properties()

Description copied from interface: ProjectContext

Returns the system properties.

Specified by:

properties in interface ProjectContext

Returns:

the system properties

environment

public String environment(String name)

Description copied from interface: ProjectContext

Returns the environment variable.

Specified by:

environment in interface ProjectContext

Parameters:

name - the variable name

Returns:

the variable value, or null if it is not defined

property

public String property(String key)

Description copied from interface: ProjectContext

Returns the system property.

Specified by:

property in interface ProjectContext

Parameters:

key - the property key

Returns:

the property value, or null if it is not defined

getDirectory

protected abstract Path getDirectory()

Returns the project directory.

Returns:

the project directory

getCommandLauncher

public CommandLauncher getCommandLauncher()

Description copied from interface: ProjectContext

Returns a command launcher of this context.

Specified by:

getCommandLauncher in interface ProjectContext

Returns:

a command launcher

with

public TSelf with(Consumer<? super TSelf> configurator)

Configures this project.

Parameters:

configurator - the configurator

Returns:

this

withEnvironment

public TSelf withEnvironment(String name,
                             String value)

Puts an environment variable.

Parameters:

name - the variable name

value - the variable value (nullable)

Returns:

this

withEnvironment

public TSelf withEnvironment(Consumer<? super Map<String,String>> configurator)

Sets the environment variables.

Parameters:

configurator - the configurator

Returns:

this

withProperty

public TSelf withProperty(String name,
                          String value)

Puts an system property.

Parameters:

name - the variable name

value - the variable value (nullable)

Returns:

this

withProperties

public TSelf withProperties(Consumer<? super Map<String,String>> configurator)

Sets the system properties.

Parameters:

configurator - the configurator

Returns:

this

getContents

public Bundle getContents()

Returns the project bundle.

Returns:

the project bundle

withContents

public TSelf withContents(TryConsumer<? super Bundle,IOException> configurator)

Returns the project bundle.

Parameters:

configurator - the project configurator

Returns:

this

gradle

public TSelf gradle(String... tasks)

Launches Gradle tasks.

Parameters:

tasks - the task names

Returns:

this

See Also:

gradle(TryConsumer)

gradle

public TSelf gradle(TryConsumer<? super GradleAdapter,IOException> configurator)

Proceeds Gradle actions on this project.

Parameters:

configurator - the Gradle action configurator

Returns:

this

See Also:

gradle(String...)

getBundle

protected Bundle getBundle(Path path)

Returns a project related bundle.

Parameters:

path - the bundle path

Returns:

the created bundle

configure

protected <T> TSelf configure(T object,
                              TryConsumer<? super T,IOException> configurator)

Configures the given object.

Type Parameters:

T - the object type

Parameters:

object - the target object

configurator - the object configurator

Returns:

this