org.codehaus.enunciate.modules.docs.config
Class DownloadConfig

java.lang.Object
  extended by org.codehaus.enunciate.modules.docs.config.DownloadConfig

public class DownloadConfig
extends java.lang.Object

Configuration for a download.

Author:
Ryan Heaton

Constructor Summary
DownloadConfig()
           
 
Method Summary
 java.lang.String getArtifact()
          The artifact to expose as a download.
 java.lang.String getDescription()
          The description of the download.
 java.lang.String getFile()
          The file to expose as a download.
 java.lang.String getName()
          The name of the download.
 void setArtifact(java.lang.String artifact)
          The artifact to expose as a download.
 void setDescription(java.lang.String description)
          The description of the download.
 void setFile(java.lang.String file)
          The file to expose as a download.
 void setName(java.lang.String name)
          The name of the download.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DownloadConfig

public DownloadConfig()
Method Detail

getArtifact

public java.lang.String getArtifact()
The artifact to expose as a download.

Returns:
The artifact to expose as a download.

setArtifact

public void setArtifact(java.lang.String artifact)
The artifact to expose as a download.

Parameters:
artifact - The artifact to expose as a download.

getName

public java.lang.String getName()
The name of the download.

Returns:
The name of the download.

setName

public void setName(java.lang.String name)
The name of the download.

Parameters:
name - The name of the download.

getDescription

public java.lang.String getDescription()
The description of the download. (Ignored if "artifact" is set.)

Returns:
The description of the download. (Ignored if "artifact" is set.)

setDescription

public void setDescription(java.lang.String description)
The description of the download. (Ignored if "artifact" is set.)

Parameters:
description - The description of the download. (Ignored if "artifact" is set.)

getFile

public java.lang.String getFile()
The file to expose as a download. (Ignored if "artifact" is set.)

Returns:
The file to expose as a download. (Ignored if "artifact" is set.)

setFile

public void setFile(java.lang.String file)
The file to expose as a download. (Ignored if "artifact" is set.)

Parameters:
file - The file to expose as a download. (Ignored if "artifact" is set.)