com.codemonster.surinam.export.meta
Annotation Type ProviderImplementationInfo
@Documented
@Retention(value=RUNTIME)
public @interface ProviderImplementationInfo
This is the primary annotation for Provider Implementations; see individual fields for detail on each.
- Author:
- Samuel Provencher
Required Element Summary |
String |
author
This would be the individual contact of record for this release. |
String |
description
Since this annotation is attached to a specific class, it is also appropriate to provide some
short description of what this implementation is all about. |
String |
organization
For larger organizations who are implementation providers, they can identify themselves here,
possibly including some contact information. |
String |
releaseDate
This is the date of record for this released version of the implementation. |
String |
version
Since this is information about a release which is tied to a snapshot of source and/or binaries,
we allow version information to be provided here. |
String |
webAddress
For cases where there might be a web identity, providers and add that here. |
author
public abstract String author
- This would be the individual contact of record for this release. For corporate releases there might
be something like (i.e. "userSupport@acme.com") and for individual implementation
providers who don't have a corporate identity ("Rich Programmer a.k.a dick@richardsoftware.org").
- Returns:
- Returns an informative string about the author.
organization
public abstract String organization
- For larger organizations who are implementation providers, they can identify themselves here,
possibly including some contact information.
- Returns:
- Returns an informative identification string here.
version
public abstract String version
- Since this is information about a release which is tied to a snapshot of source and/or binaries,
we allow version information to be provided here. We do not require that a version be in the
expected numerical format since we want to allow releases do determine what model and granularity
works best for them (i.e. "1.02", "Oct-2007"). We recommend that versions remain numeric unless
there is a good reason to favor another method.
- Returns:
- Returns the version string for this implementation.
releaseDate
public abstract String releaseDate
- This is the date of record for this released version of the implementation. While a release version
might have date information embedded in it, the expectation is that it would not be very fine-grained
since that would make it too subject to change as a release dates move.
- Returns:
- Returns the string representing the official release date for this implementation.
webAddress
public abstract String webAddress
- For cases where there might be a web identity, providers and add that here. This might be particularly
useful in cases where you want to be able to check for newer versions of a given library.
- Returns:
- Returns the string message that may include a web location.
description
public abstract String description
- Since this annotation is attached to a specific class, it is also appropriate to provide some
short description of what this implementation is all about.
- Returns:
- Returns a short description of the implementation.
Copyright © 2010. All Rights Reserved.