org.gradle.api.internal.artifacts.publish

Class DefaultPublishArtifact

java.lang.Object

org.gradle.api.internal.artifacts.publish.AbstractPublishArtifact

org.gradle.api.internal.artifacts.publish.DefaultPublishArtifact

All Implemented Interfaces:

ConfigurablePublishArtifact, PublishArtifact, Buildable

public class DefaultPublishArtifact
extends AbstractPublishArtifact
implements ConfigurablePublishArtifact

Author:

Hans Dockter

Constructor Summary

Constructors

Constructor and Description
DefaultPublishArtifact(String name, String extension, String type, String classifier, Date date, File file, Object... tasks)

Method Summary

Methods

Modifier and Type	Method and Description
DefaultPublishArtifact	builtBy(Object... tasks) Registers some tasks which build this artifact.
String	getClassifier() Returns the classifier of this published artifact, if any.
Date	getDate() Returns the date that should be used when publishing this artifact.
String	getExtension() Returns the extension of this published artifact.
File	getFile() Returns the file of this artifact.
String	getName() Returns the name of the artifact.
String	getType() Returns the type of the published artifact.
void	setClassifier(String classifier) Sets the classifier of this artifact.
void	setDate(Date date)
void	setExtension(String extension) Sets the extension of this artifact.
void	setFile(File file)
void	setName(String name) Sets the name of this artifact.
void	setType(String type) Sets the type of this artifact.

Methods inherited from class org.gradle.api.internal.artifacts.publish.AbstractPublishArtifact

getBuildDependencies, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.Buildable

getBuildDependencies

Constructor Detail

DefaultPublishArtifact

public DefaultPublishArtifact(String name,
                      String extension,
                      String type,
                      String classifier,
                      Date date,
                      File file,
                      Object... tasks)

Method Detail

builtBy

public DefaultPublishArtifact builtBy(Object... tasks)

Description copied from interface: ConfigurablePublishArtifact

Registers some tasks which build this artifact.

Specified by:

builtBy in interface ConfigurablePublishArtifact

Overrides:

builtBy in class AbstractPublishArtifact

Parameters:

tasks - The tasks. These are evaluated as for Task.dependsOn(Object...).

Returns:

this

getName

public String getName()

Description copied from interface: PublishArtifact

Returns the name of the artifact.

Specified by:

getName in interface PublishArtifact

Returns:

The name. Never null.

getExtension

public String getExtension()

Description copied from interface: PublishArtifact

Returns the extension of this published artifact. Often the extension is the same as the type, but sometimes this is not the case. For example for an ivy xml module descriptor, the type is ivy and the extension is xml.

Specified by:

getExtension in interface PublishArtifact

Returns:

The extension. Never null.

getType

public String getType()

Description copied from interface: PublishArtifact

Returns the type of the published artifact. Often the type is the same as the extension, but sometimes this is not the case. For example for an ivy xml module descriptor, the type is ivy and the extension is xml.

Specified by:

getType in interface PublishArtifact

Returns:

The type. Never null.

getClassifier

public String getClassifier()

Description copied from interface: PublishArtifact

Returns the classifier of this published artifact, if any.

Specified by:

getClassifier in interface PublishArtifact

Returns:

The classifier. May be null.

getFile

public File getFile()

Description copied from interface: PublishArtifact

Returns the file of this artifact.

Specified by:

getFile in interface PublishArtifact

Returns:

The file. Never null.

getDate

public Date getDate()

Description copied from interface: PublishArtifact

Returns the date that should be used when publishing this artifact. This is used in the module descriptor accompanying this artifact (the ivy.xml). If the date is not specified, the current date is used. If this artifact is published without an module descriptor, this property has no relevance.

Specified by:

getDate in interface PublishArtifact

Returns:

The date. May be null.

setName

public void setName(String name)

Description copied from interface: ConfigurablePublishArtifact

Sets the name of this artifact.

Specified by:

setName in interface ConfigurablePublishArtifact

Parameters:

name - The name. Should not be null.

setExtension

public void setExtension(String extension)

Description copied from interface: ConfigurablePublishArtifact

Sets the extension of this artifact.

Specified by:

setExtension in interface ConfigurablePublishArtifact

Parameters:

extension - The extension. Should not be null.

setType

public void setType(String type)

Description copied from interface: ConfigurablePublishArtifact

Sets the type of this artifact.

Specified by:

setType in interface ConfigurablePublishArtifact

Parameters:

type - The type. Should not be null.

setClassifier

public void setClassifier(String classifier)

Description copied from interface: ConfigurablePublishArtifact

Sets the classifier of this artifact.

Specified by:

setClassifier in interface ConfigurablePublishArtifact

Parameters:

classifier - The classifier. May be null.

setDate

public void setDate(Date date)

setFile

public void setFile(File file)