org.codehaus.enunciate.main
Interface Artifact

All Superinterfaces:
java.lang.Comparable<Artifact>
All Known Subinterfaces:
ArtifactBundle, NamedArtifact
All Known Implementing Classes:
BaseArtifact, ClientLibraryArtifact, DownloadBundle, FileArtifact, NamedFileArtifact, TextArtifact

public interface Artifact
extends java.lang.Comparable<Artifact>

An artifact that can be exported by Enunciate.

Author:
Ryan Heaton

Method Summary
 void exportTo(java.io.File fileOrDirectory, Enunciate enunciate)
          Exports this artifact to the specified file or directory.
 java.util.Set<java.lang.String> getAliases()
          A list of aliases for this artifact.
 java.util.List<ArtifactDependency> getDependencies()
          The list of dependencies for this artifact.
 java.lang.String getId()
          The id of the artifact.
 java.lang.String getModule()
          The name of the module that published this artifact.
 long getSize()
          The size, in bytes, of this artifact.
 boolean isPublic()
          Whether this artifact is bundled with others in an ArtifactBundle.
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getId

java.lang.String getId()
The id of the artifact.

Returns:
The id of the artifact.

getModule

java.lang.String getModule()
The name of the module that published this artifact.

Returns:
The name of the module that published this artifact.

exportTo

void exportTo(java.io.File fileOrDirectory,
              Enunciate enunciate)
              throws java.io.IOException
Exports this artifact to the specified file or directory.

Parameters:
fileOrDirectory - The file or directory to export to.
enunciate - The enunciate mechanism to use for utilities and properties as necessary.
Throws:
java.io.IOException - If an error occurs exporting it.

getSize

long getSize()
The size, in bytes, of this artifact.

Returns:
The size, in bytes, of this artifact.

isPublic

boolean isPublic()
Whether this artifact is bundled with others in an ArtifactBundle.

Returns:
Whether this artifact is bundled elsewhere.

getDependencies

java.util.List<ArtifactDependency> getDependencies()
The list of dependencies for this artifact.

Returns:
The list of dependencies for this artifact.

getAliases

java.util.Set<java.lang.String> getAliases()
A list of aliases for this artifact.

Returns:
The set of aliases for this artifact.