net.java.ao.schema

Annotation Type Ignore

@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface Ignore

Marks a method as to be ignored by the schema generation engine. This annotation has no effect on the normal "runtime" behavior of the method or its containing entity.

As a general rule, it's a good idea to use this annotation on any method which does not have a one-to-one correspondance with a database field. For example, utility methods within the entity which perform high-level operations upon the data rather than acting as a simple bean interface to a field. Not using this annotation in such a case is perfectly acceptable and will not lead to any problems in the actual invocation. However, if a migration is run against an entity containing such a method, extraneous fields may be generated and the migration may even fail completely.

This annotation is only relevant to migrations. It has no effect upon "runtime" entity usage.

Author:

Daniel Spiewak