org.codehaus.mojo.servicedocgen.descriptor

Class ErrorDescriptor

java.lang.Object

org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

org.codehaus.mojo.servicedocgen.descriptor.ErrorDescriptor

All Implemented Interfaces:

Descriptor

public class ErrorDescriptor
extends AbstractDescriptor

Descriptor for errors/exceptions (any kind of Throwable).

Author:

hohwille

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorDescriptor.Match Mode to match error name.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_JSON_EXAMPLE Default for getJsonExample().
static String	DEFAULT_XML_EXAMPLE Default for getXmlExample().

Fields inherited from interface org.codehaus.mojo.servicedocgen.descriptor.Descriptor

HTTP_METHOD_DELETE, HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_OPTIONS, HTTP_METHOD_PATCH, HTTP_METHOD_POST, HTTP_METHOD_PUT, LOCATION_BODY, LOCATION_COOKIE, LOCATION_FORM_DATA, LOCATION_HEADER, LOCATION_PATH, LOCATION_QUERY, SCHEME_HTTP, SCHEME_HTTPS, SCHEME_WS, SCHEME_WSS, STATUS_CODE_BAD_REQUEST, STATUS_CODE_CONFLICT, STATUS_CODE_FORBIDDEN, STATUS_CODE_INTERNAL_SERVER_ERROR, STATUS_CODE_NO_CONTENT, STATUS_CODE_SUCCESS, STATUS_CODE_UNAUTHORIZED

Constructor Summary

Constructors

Constructor and Description
ErrorDescriptor()

Method Summary

Modifier and Type	Method and Description
String	getComment()
Class<?>	getErrorClass()
String	getErrorName()
Pattern	getErrorNamePattern()
String	getJsonExample()
ErrorDescriptor.Match	getMatch()
String	getStatusCode()
String	getXmlExample()
void	setComment(String comment)
void	setErrorClass(Class<?> errorClass)
void	setErrorName(String errorNameRegex)
void	setJsonExample(String jsonExample)
void	setMatch(ErrorDescriptor.Match match)
void	setStatusCode(String statusCode)
void	setXmlExample(String xmlExample)
String	toString()

Methods inherited from class org.codehaus.mojo.servicedocgen.descriptor.AbstractDescriptor

notNull

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_JSON_EXAMPLE

public static final String DEFAULT_JSON_EXAMPLE

Default for getJsonExample().

See Also:

Constant Field Values

DEFAULT_XML_EXAMPLE

public static final String DEFAULT_XML_EXAMPLE

Default for getXmlExample().

See Also:

Constant Field Values

Constructor Detail

ErrorDescriptor

public ErrorDescriptor()

Method Detail

getErrorName

public String getErrorName()

Returns:

the errorNameRegex

setErrorName

public void setErrorName(String errorNameRegex)

Parameters:

errorNameRegex - is the errorNameRegex to set

getJsonExample

public String getJsonExample()

Returns:

the jsonExample

setJsonExample

public void setJsonExample(String jsonExample)

Parameters:

jsonExample - is the jsonExample to set

getXmlExample

public String getXmlExample()

Returns:

the xmlExample

setXmlExample

public void setXmlExample(String xmlExample)

Parameters:

xmlExample - is the xmlExample to set

getStatusCode

public String getStatusCode()

Returns:

the statusCode

setStatusCode

public void setStatusCode(String statusCode)

Parameters:

statusCode - is the statusCode to set

getComment

public String getComment()

Returns:

the comment to use if no more specific comment is available (esp. in case of ErrorDescriptor.Match.always).

setComment

public void setComment(String comment)

Parameters:

comment - is the comment to set

getErrorNamePattern

public Pattern getErrorNamePattern()

Returns:

the errorNamePattern

getMatch

public ErrorDescriptor.Match getMatch()

Returns:

the match

setMatch

public void setMatch(ErrorDescriptor.Match match)

Parameters:

match - is the match to set

getErrorClass

public Class<?> getErrorClass()

Returns:

the errorClass

setErrorClass

public void setErrorClass(Class<?> errorClass)

Parameters:

errorClass - is the errorClass to set

toString

public String toString()

Overrides:

toString in class Object