Package com.storedobject.common.annotation

Annotation Interface Module

@Documented
@Target(PACKAGE)
@Retention(RUNTIME)
public @interface Module

Annotation to define metadata for a module. This annotation is used to specify attributes related to a software module, including its name, description, version, vendor, and other key properties.

Author:

Syam

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	moduleName	Retrieves the name of the module.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
int	build	Retrieves the build number of the module.
String	description	Provides a description of the module.
String	jarName	Specifies the name of the JAR file associated with the module.
int	release	Retrieves the release number of the module.
String	vendor	Retrieves the vendor information associated with the module.
String	version	Retrieves the version of the module.
int	year	Retrieves the year associated with the module.

Element Details

moduleName

String moduleName

Retrieves the name of the module.

Returns:

the name of the module as a string

description

String description

Provides a description of the module.

Returns:

the description of the module as a string, or an empty string if no description is provided

Default:

""

jarName

String jarName

Specifies the name of the JAR file associated with the module.

Returns:

the name of the JAR file as a string, or an empty string if no JAR name is defined

Default:

""

build

int build

Retrieves the build number of the module.

Returns:

the build number of the module as an integer, or 0 if no build number is specified

Default:

0

release

int release

Retrieves the release number of the module.

Returns:

the release number of the module as an integer, or 0 if no release number is specified

Default:

0

version

String version

Retrieves the version of the module.

Returns:

the version of the module as a string, or an empty string if no version is specified

Default:

""

vendor

String vendor

Retrieves the vendor information associated with the module.

Returns:

the vendor information as a string. If no vendor information is specified, it defaults to "www.storedobject.com".

Default:

"www.storedobject.com"

year

int year

Retrieves the year associated with the module.

Returns:

the year as an integer, or 0 if no year is specified

Default:

0