fr.ifremer.isisfish.util
Interface Docable

All Known Implementing Classes:

AnalysePlanStorage, ExportStorage, RuleStorage, ScriptStorage, SensitivityExportStorage, SensitivityStorage

public interface Docable

This is the contract to be realize by any class which wanted to have a @Doc support.

Version:

$Revision: 2088 $ Last update : $Date: 2009-04-08 12:24:31 +0200 (mer., 08 avril 2009) $ By : $Author: chatellier $

Author:

chemit

See Also:

Doc, DocHelper

Method Summary

Doc	getClassDoc() Class documentation (if any).
java.lang.String	getDescription() Class documentation (if any).
Doc	getFieldDoc(java.lang.String fieldName) Field documentation (if any).

Method Detail

getClassDoc

Doc getClassDoc()

Class documentation (if any).

Returns:

the @Doc of the class, or null if none

getFieldDoc

Doc getFieldDoc(java.lang.String fieldName)

Field documentation (if any).

Parameters:

fieldName - name of the field to use

Returns:

the @Doc of the field, or null if none

getDescription

java.lang.String getDescription()

Class documentation (if any).

Returns:

the description of the class, or null if none