org.restdoc.api.util

Class RestDocObject

java.lang.Object

org.restdoc.api.util.RestDocObject

Direct Known Subclasses:

ExampleRequest, GlobalHeader, HeaderDefinition, MethodDefinition, ParamDefinition, ParamValidation, Representation, ResponseDefinition, RestDoc, RestResource, Schema

public class RestDocObject
extends Object

Author:

hoegertn

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,Object>	additionalFields

Constructor Summary

Constructors

Constructor and Description
RestDocObject()

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getAdditionalBoolean(String fieldName)
Object	getAdditionalField(String fieldName)
Map<String,Object>	getAdditionalFields()
Number	getAdditionalNumber(String fieldName)
String	getAdditionalString(String fieldName)
void	setAdditionalField(String key, Object value) Add additional field

Methods inherited from class java.lang.Object

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

Field Detail

additionalFields

protected final HashMap<String,Object> additionalFields

Constructor Detail

RestDocObject

public RestDocObject()

Method Detail

getAdditionalFields

public Map<String,Object> getAdditionalFields()

Returns:

the map of additional fields

setAdditionalField

public void setAdditionalField(String key,
                      Object value)

Add additional field

Parameters:

key - the field name

value - the field value

getAdditionalField

public Object getAdditionalField(String fieldName)

Parameters:

fieldName -

Returns:

the value as Object

getAdditionalString

public String getAdditionalString(String fieldName)

Parameters:

fieldName -

Returns:

the value as String

getAdditionalNumber

public Number getAdditionalNumber(String fieldName)
                           throws ParseException

Parameters:

fieldName -

Returns:

the value as Number

Throws:

ParseException

getAdditionalBoolean

public Boolean getAdditionalBoolean(String fieldName)

Parameters:

fieldName -

Returns:

the value as Boolean