gov.sandia.cognition.annotation
Annotation Type SoftwareReference


@CodeReview(reviewer="Kevin R. Dixon",
            date="2008-12-02",
            changesNeeded=false,
            comments="Looks good.")
@Retention(value=RUNTIME)
@Documented
public @interface SoftwareReference

Describes a reference to software. The purpose of this annotation is to provide a reference to a piece of software so that someone would be able to find it on the Internet using a search engine. This is typically used when a class wraps or uses some third-party library.

Since:
3.0
Author:
Justin Basilico

Required Element Summary
 SoftwareLicenseType license
          The type of license for the software.
 String name
          The full name of the software.
 String version
          The specific version of the software that is used.
 
Optional Element Summary
 String date
          An optional date on which the reference was made.
 String licenseURL
          An optional URL for the software license.
 String licenseVersion
          An optional version for the license.
 String[] notes
          Optional notes regarding this reference.
 String url
          An optional URL reference to where the software can be found.
 

Element Detail

name

public abstract String name
The full name of the software.

Returns:
The full name of the software.

version

public abstract String version
The specific version of the software that is used. For example, "1.6.0".

Returns:
The specific version of the software.

license

public abstract SoftwareLicenseType license
The type of license for the software. If the selection is Other, please specify in the notes section.

Returns:
The type of license for the software.

date

public abstract String date
An optional date on which the reference was made. Useful for projects whose versions do not make much sense, or to locate the exact version used. Defaults to "".

Returns:
The date on which the software reference was made.
Default:
""

url

public abstract String url
An optional URL reference to where the software can be found. Typically, the home-page for the software. Defaults to "".

Returns:
A URL where the software can be found.
Default:
""

licenseVersion

public abstract String licenseVersion
An optional version for the license. Defaults to "".

Returns:
The version for the license.
Default:
""

licenseURL

public abstract String licenseURL
An optional URL for the software license. Defaults to "".

Returns:
A URL where the software license can be found.
Default:
""

notes

public abstract String[] notes
Optional notes regarding this reference.

Returns:
Optional notes regarding this reference.
Default:
""