fr.ifremer.isisfish.util

Interface Docable

All Known Implementing Classes:

ExportStorage, JavaSourceStorage, RuleStorage, ScriptStorage, SensitivityAnalysisStorage, SensitivityExportStorage, SimulationPlanStorage, SimulatorStorage

public interface Docable

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

Version:

$Revision: 3798 $ Last update : $Date: 2012-10-30 11:39:32 +0100 (Tue, 30 Oct 2012) $ By : $Author: echatellier $

Author:

chemit

See Also:

Doc

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Class documentation (if any).
Doc	getFieldDoc(String fieldName) Field documentation (if any).

Method Detail

getFieldDoc

Doc getFieldDoc(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

String getDescription()

Class documentation (if any).

Returns:

the description of the class, or null if none