de.h2b.basis
Annotation Type ClassLabel


@ClassLabel(copyright="Copyright (C) 2008 Hans-Hermann Bode",
            ident="$Id: ClassLabel.java,v 1.2 2008/11/29 01:34:33 h2b Exp $")
@Documented
@Retention(value=CLASS)
@Target(value=TYPE)
public @interface ClassLabel

An annotation type for putting certain information into a class file. There are a copyright and an identifier element that can be used appropriately. Both have a default empty-string value, respectively, so that one is able to use one or both of them (or none, although this wouldn't make too much sense).

The retention policy for the annotation is to be recorded in the class file by the compiler but need not be retained by the VM at run time. (This is the default behavior.)

The annotation is targeted for class, interface (including annotation type), or enum declaration.

Since:
h2basis 0.0.1
Version:
$Revision: 1.2 $, $Date: 2008/11/29 01:34:33 $
Author:
h2b

Optional Element Summary
 java.lang.String copyright
          To be used for a copyright notification.
 java.lang.String ident
          To be used for an identifier.
 

copyright

public abstract java.lang.String copyright
To be used for a copyright notification.

Returns:
the copyright notification
Default:
""

ident

public abstract java.lang.String ident
To be used for an identifier. Typically this may be some string generated by keyword substitution from a version control system.

Returns:
the identifier
Default:
""


Copyright © 2008 Hans-Hermann Bode, Berlin, Germany. All Rights Reserved.