fr.ifremer.isisfish.util
Class DocHelper

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

public class DocHelper
extends java.lang.Object

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

Author:

chemit

Constructor Summary

DocHelper()

Method Summary

static java.lang.String	asString(Doc doc)
static java.lang.String	getAuthor(Doc doc)
static Doc	getClassDoc(java.lang.Class<?> klazz)
static Doc	getClassDoc(java.lang.Object value)
static java.lang.String	getDate(Doc doc)
static Doc	getFieldDoc(java.lang.Class klazz, java.lang.String fieldName)
static Doc	getFieldDoc(java.lang.reflect.Field f)
static java.lang.String	getValue(Doc doc)
static java.lang.String	getVersion(Doc doc)

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(java.lang.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(java.lang.Object value)

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(java.lang.reflect.Field f)

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(java.lang.Class klazz,
                              java.lang.String fieldName)

Parameters:

klazz - klazz to use

fieldName - flied name ot use

Returns:

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

getValue

public static java.lang.String getValue(Doc doc)

Parameters:

doc - doc to use

Returns:

the Doc.value() of the given @Doc

getAuthor

public static java.lang.String getAuthor(Doc doc)

Parameters:

doc - doc to use

Returns:

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

getDate

public static java.lang.String getDate(Doc doc)

Parameters:

doc - doc to use

Returns:

the Doc.date() of the given @Doc

getVersion

public static java.lang.String getVersion(Doc doc)

Parameters:

doc - doc to use

Returns:

the Doc.version() of the given @Doc

asString

public static java.lang.String asString(Doc doc)

Parameters:

doc - the doc to use

Returns:

a string nicely print version