fr.ifremer.isisfish.util
Class DocHelper

java.lang.Object
  fr.ifremer.isisfish.util.DocHelper

public class DocHelper
extends Object

Class containing usefull methods to obtain @Doc informations for a class,field,method...

Version:

$Revision: 3124 $ Last update : $Date: 2010-11-29 19:14:09 +0100 (lun., 29 nov. 2010) $ By : $Author: chatellier $

Author:

chemit

Constructor Summary

DocHelper()

Method Summary

static String	getAuthor(Doc doc) Deprecated. as of 20090408 never used
static Doc	getClassDoc(Class<?> klazz)
static Doc	getClassDoc(Object value) Deprecated. as of 20090408 never used
static String	getDate(Doc doc) Deprecated. as of 20090408 never used
static Doc	getFieldDoc(Class<?> klazz, String fieldName)
static Doc	getFieldDoc(Field f) Deprecated. as of 20090408 never used
static String	getValue(Doc doc) Deprecated. as of 20090408 never used
static String	getVersion(Doc doc) Deprecated. as of 20090408 never used

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocHelper

public DocHelper()

Method Detail

getClassDoc

public static Doc getClassDoc(Class<?> klazz)

Parameters:

klazz - class to use

Returns:

the @Doc associated with the class of null if klazz is null or there is no Doc for this klazz

getClassDoc

public static Doc getClassDoc(Object value)

Deprecated. as of 20090408 never used

Parameters:

value - object given

Returns:

the @Doc associated to the class of the given object, or null if value is null or no doc found for his class

getFieldDoc

public static Doc getFieldDoc(Field f)

Deprecated. as of 20090408 never used

Parameters:

f - file to use

Returns:

the @Doc associated to the field, or null if field is null of no @doc found

getFieldDoc

public static Doc getFieldDoc(Class<?> klazz,
                              String fieldName)

Parameters:

klazz - class to use

fieldName - field name to use

Returns:

the @Doc associated with e filed of the given class, or null if class is null, field does not exist, or no Doc for the field

getValue

public static String getValue(Doc doc)

Deprecated. as of 20090408 never used

Parameters:

doc - doc to use

Returns:

the Doc.value() of the given @Doc

getAuthor

public static String getAuthor(Doc doc)

Deprecated. as of 20090408 never used

Parameters:

doc - doc to use

Returns:

the Doc.author()} of the given @Doc

getDate

public static String getDate(Doc doc)

Deprecated. as of 20090408 never used

Parameters:

doc - doc to use

Returns:

the Doc.date() of the given @Doc

getVersion

public static String getVersion(Doc doc)

Deprecated. as of 20090408 never used

Parameters:

doc - doc to use

Returns:

the Doc.version() of the given @Doc