org.myire.quill.configuration

Class ConfigurationSpec

java.lang.Object

org.myire.quill.configuration.ConfigurationSpec

All Implemented Interfaces:

PrettyPrintable

public class ConfigurationSpec
extends java.lang.Object
implements PrettyPrintable

Specification of a configuration.

Constructor Summary

Constructors

Constructor and Description
ConfigurationSpec(java.lang.String pName) Create a new ConfigurationSpec.

Method Summary

Modifier and Type	Method and Description
void	addExtendedConfiguration(java.lang.String pConfigurationName) Add the name of a configuration that is extended by this configuration.
void	forEachExtendedConfiguration(java.util.function.Consumer<? super java.lang.String> pAction) Perform an action for the name of each configuration extended by this configuration.
java.lang.String	getDescription()
java.lang.String	getName()
int	getNumExtendedConfigurations() Get the number of configurations that are extended by this configuration.
boolean	isTransitive()
boolean	isVisible()
void	prettyPrint(GradlePrettyPrinter pPrinter) Pretty print this instance with a GradlePrettyPrinter on a format suitable for build scripts.
static void	prettyPrintConfigurations(GradlePrettyPrinter pPrinter, java.util.Collection<? extends ConfigurationSpec> pConfigurations) Pretty print a collection of configuration specifications on Gradle repository closure format.
void	setDescription(java.lang.String pDescription)
void	setTransitive(boolean pTransitive)
void	setVisible(boolean pVisible)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.myire.quill.common.PrettyPrintable

quote

Constructor Detail

ConfigurationSpec

public ConfigurationSpec(java.lang.String pName)

Create a new ConfigurationSpec.

Parameters:

pName - The name of the configuration.

Throws:

java.lang.NullPointerException - if pName is null.

Method Detail

getName

public java.lang.String getName()

isTransitive

public boolean isTransitive()

setTransitive

public void setTransitive(boolean pTransitive)

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean pVisible)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String pDescription)

getNumExtendedConfigurations

public int getNumExtendedConfigurations()

Get the number of configurations that are extended by this configuration.

Returns:

The number of extended configurations.

forEachExtendedConfiguration

public void forEachExtendedConfiguration(java.util.function.Consumer<? super java.lang.String> pAction)

Perform an action for the name of each configuration extended by this configuration.

Parameters:

pAction - The action to apply to the names of the extended configurations.

Throws:

java.lang.NullPointerException - if pAction is null.

addExtendedConfiguration

public void addExtendedConfiguration(java.lang.String pConfigurationName)

Add the name of a configuration that is extended by this configuration.

Parameters:

pConfigurationName - The name of the configuration that is extended by this configuration.

Throws:

java.lang.NullPointerException - if pConfigurationName is null.

prettyPrint

public void prettyPrint(GradlePrettyPrinter pPrinter)

Description copied from interface: PrettyPrintable

Pretty print this instance with a GradlePrettyPrinter on a format suitable for build scripts.

Specified by:

prettyPrint in interface PrettyPrintable

Parameters:

pPrinter - The printer to print with.

prettyPrintConfigurations

public static void prettyPrintConfigurations(GradlePrettyPrinter pPrinter,
                                             java.util.Collection<? extends ConfigurationSpec> pConfigurations)

Pretty print a collection of configuration specifications on Gradle repository closure format.

Parameters:

pPrinter - The printer to print with.

pConfigurations - The configurations to print.

Throws:

java.lang.NullPointerException - if any of the parameters is null.