Package dev.nokee.commons.names

Class TaskName

java.lang.Object

dev.nokee.commons.names.TaskName

All Implemented Interfaces:

ElementName, Name, Qualifiable, Comparable<Name>

public final class TaskName
extends Object
implements ElementName

Represents a task name in Gradle. Task name has three distinct scheme:

• verb-only: linkTest - see ElementName.taskName(String)
• verb and object: compileTestCpp, processTestResources - see ElementName.taskName(String, String)
• object-only: testClasses, testJar - see ElementName.taskName() and TaskName.Builder.forObject(String)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TaskName.Builder

Method Summary

Modifier and Type	Method	Description
static TaskName.Builder	builder()
int	compareTo(String obj)
boolean	equals(Object obj)
Object	get(String propName)
Optional<String>	getObject()
Optional<String>	getVerb()
int	hashCode()
static TaskName	of(String taskName)	Returns an TaskName instance where qualifiers are appended to the specified task name.
static TaskName	of(String verb, String object)	Returns an TaskName instance where qualifiers are sandwiched between the specified verb and object (sometime referred as target).
Set<String>	propSet()
FullyQualifiedName	qualifiedBy(Qualifier qualifier)	Creates a new qualified name for the specified qualifier.
static String	taskName(String verb, String object)	Deprecated.
String	toString()
TaskName	with(String propName, Object value)
TaskName	withObject(String object)
TaskName	withVerb(String verb)

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.nokee.commons.names.Name

compareTo, get, toString

Method Details

getVerb

public Optional<String> getVerb()

withVerb

public TaskName withVerb(String verb)

getObject

public Optional<String> getObject()

withObject

public TaskName withObject(@Nullable
 String object)

qualifiedBy

public FullyQualifiedName qualifiedBy(Qualifier qualifier)

Description copied from interface: ElementName

Creates a new qualified name for the specified qualifier.

Specified by:

qualifiedBy in interface ElementName

Specified by:

qualifiedBy in interface Qualifiable

Parameters:

qualifier - the qualifier for this name, must not be null

Returns:

a new QualifiedName representing the qualifying of this name

of

public static TaskName of(String taskName)

Returns an TaskName instance where qualifiers are appended to the specified task name. For example:

• taskNameSomeQualifier

Parameters:

taskName - the task name, must not be null

Returns:

a qualifiable task name

of

public static TaskName of(String verb,
 String object)

Returns an TaskName instance where qualifiers are sandwiched between the specified verb and object (sometime referred as target). For example:

• verbSomeQualifierObject

Parameters:

verb - the verb for the task name, must not be null

object - the object/target for the task name, must not be null

Returns:

a qualifiable task name

taskName

@Deprecated
public static String taskName(String verb,
 String object)

Deprecated.

Description copied from interface: ElementName

Creates a task name for the specified name.

Parameters:

verb - the verb (prefix), must not be null

object - the object (suffix), must not be null

Returns:

a qualifiable name instance

toString

public String toString()

builder

public static TaskName.Builder builder()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(String obj)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

propSet

public Set<String> propSet()

with

public TaskName with(String propName,
 Object value)

get

public Object get(String propName)