org.myire.quill.report

Class DefaultFormatChoiceReport

java.lang.Object

org.myire.quill.common.ProjectAware

org.myire.quill.report.SimpleConfigurableReport

org.myire.quill.report.DefaultDestinationReport

org.myire.quill.report.DefaultSingleFileReport

org.myire.quill.report.DefaultFormatChoiceReport

All Implemented Interfaces:

org.gradle.api.reporting.ConfigurableReport, org.gradle.api.reporting.Report, org.gradle.api.reporting.SingleFileReport, org.gradle.util.Configurable<org.gradle.api.reporting.Report>, FormatChoiceReport

public class DefaultFormatChoiceReport
extends DefaultSingleFileReport
implements FormatChoiceReport

A FormatChoiceReport with a default destination.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.reporting.Report

org.gradle.api.reporting.Report.OutputType

Field Summary

Fields inherited from interface org.gradle.api.reporting.Report

NAMER

Constructor Summary

Constructors

Constructor and Description
DefaultFormatChoiceReport(org.gradle.api.Project pProject, java.lang.String pName, java.lang.String pDisplayName, java.lang.String pDefaultFormat, groovy.lang.Closure<java.io.File> pDefaultDestination) Create a new DefaultFormatChoiceReport.

Method Summary

Modifier and Type	Method and Description
void	addLegalFormats(java.lang.String... pFormats) Add a sequence of formats accepted by this report.
java.lang.String	getFormat() Get the selected format of the report.
void	setFormat(java.lang.String pFormat) Set the selected format of the report.

Methods inherited from class org.myire.quill.report.DefaultSingleFileReport

getOutputLocation

Methods inherited from class org.myire.quill.report.DefaultDestinationReport

resolveDestination

Methods inherited from class org.myire.quill.report.SimpleConfigurableReport

configure, getDestination, getDisplayName, getName, getOutputType, getProject, getProjectLogger, getRequired, isEnabled, reportIsRequired, setDestination, setDestination, setEnabled, setEnabled, setOutputLocation, setRequired, toString, useDestination

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.reporting.SingleFileReport

getOutputLocation, getOutputType

Methods inherited from interface org.gradle.api.reporting.ConfigurableReport

setDestination, setDestination, setEnabled, setEnabled

Methods inherited from interface org.gradle.api.reporting.Report

getDestination, getDisplayName, getName, getRequired, isEnabled

Methods inherited from interface org.gradle.util.Configurable

configure

Constructor Detail

DefaultFormatChoiceReport

public DefaultFormatChoiceReport(org.gradle.api.Project pProject,
                                 java.lang.String pName,
                                 java.lang.String pDisplayName,
                                 java.lang.String pDefaultFormat,
                                 groovy.lang.Closure<java.io.File> pDefaultDestination)

Create a new DefaultFormatChoiceReport.

Parameters:

pProject - The project for which the report will be produced.

pName - The report's symbolic name.

pDisplayName - The report's display name.

pDefaultFormat - The report's default format.

pDefaultDestination - A closure that will return the report's default file destination when called.

Throws:

java.lang.NullPointerException - if pProject or pDefaultDestination is null.

Method Detail

addLegalFormats

public void addLegalFormats(java.lang.String... pFormats)

Add a sequence of formats accepted by this report.

Parameters:

pFormats - The legal formats to add.

getFormat

public java.lang.String getFormat()

Description copied from interface: FormatChoiceReport

Get the selected format of the report.

Specified by:

getFormat in interface FormatChoiceReport

Returns:

The format.

setFormat

public void setFormat(java.lang.String pFormat)

Description copied from interface: FormatChoiceReport

Set the selected format of the report.

Specified by:

setFormat in interface FormatChoiceReport

Parameters:

pFormat - The selected format.