io.bitrise.trace.plugin.util

Class TraceTaskBuilder

java.lang.Object

io.bitrise.trace.plugin.util.TraceTaskBuilder

Direct Known Subclasses:

TraceVariantTaskBuilder

public class TraceTaskBuilder
extends java.lang.Object

Factory made for simplifying BaseTraceTask creation.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	baseName Tha base name of the task without any prefixes.
protected java.lang.String	description The description for the task.
protected java.lang.String	group The group for the task.
protected org.gradle.api.tasks.TaskContainer	taskContainer The TaskContainer that will contain the newly created task.
protected java.lang.Class<? extends BaseTraceTask>	type The type of the task.

Constructor Summary

Constructors

Constructor and Description
TraceTaskBuilder(org.gradle.api.tasks.TaskContainer taskContainer, java.lang.String baseName, java.lang.Class<? extends BaseTraceTask> type) Constructor for the class.

Method Summary

Modifier and Type	Method and Description
BaseTraceTask	build() Builds the given task based on the values that are set and adds it to the TaskContainer.
protected java.util.Map<java.lang.String,java.lang.Object>	generatePropertiesForTask(java.lang.String name, java.lang.Class<? extends BaseTraceTask> type) Creates the properties for a Gradle task.
TraceTaskBuilder	setDescription(java.lang.String description) Sets the description of the task.
TraceTaskBuilder	setGroup(java.lang.String group) Sets the group for the given task.

Methods inherited from class java.lang.Object

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

Field Detail

taskContainer

@NonNull
protected final org.gradle.api.tasks.TaskContainer taskContainer

The TaskContainer that will contain the newly created task.

baseName

@NonNull
protected final java.lang.String baseName

Tha base name of the task without any prefixes.

type

@NonNull
protected final java.lang.Class<? extends BaseTraceTask> type

The type of the task.

group

@Nullable
protected java.lang.String group

The group for the task.

description

@Nullable
protected java.lang.String description

The description for the task.

Constructor Detail

TraceTaskBuilder

public TraceTaskBuilder(@NonNull
                        org.gradle.api.tasks.TaskContainer taskContainer,
                        @NonNull
                        java.lang.String baseName,
                        @NonNull
                        java.lang.Class<? extends BaseTraceTask> type)

Constructor for the class.

Parameters:

taskContainer - the TaskContainer that will contain the created Task.

baseName - the baseName of the newly created task.

type - the class of the task.

Method Detail

setGroup

@NonNull
public TraceTaskBuilder setGroup(@Nullable
                                          java.lang.String group)

Sets the group for the given task.

Parameters:

group - the group of the given task.

Returns:

this builder.

setDescription

@NonNull
public TraceTaskBuilder setDescription(@Nullable
                                                java.lang.String description)

Sets the description of the task.

Parameters:

description - the description of the task.

Returns:

this builder.

generatePropertiesForTask

@NonNull
protected java.util.Map<java.lang.String,java.lang.Object> generatePropertiesForTask(@NonNull
                                                                                              java.lang.String name,
                                                                                              @NonNull
                                                                                              java.lang.Class<? extends BaseTraceTask> type)

Creates the properties for a Gradle task.

Parameters:

name - the name of the Task.

type - the class of the Task.

Returns:

a property Map that is required for task creation.

build

@NonNull
public BaseTraceTask build()

Builds the given task based on the values that are set and adds it to the TaskContainer.

Returns:

the newly created task.