Package com.atlassian.oai.validator.model

Class ApiOperationMatch

java.lang.Object

com.atlassian.oai.validator.model.ApiOperationMatch

public class ApiOperationMatch
extends Object

After trying to find the best matching ApiOperation this model contains the information if the path is defined, the operation is allowed and if so the ApiOperation itself, too.

Field Summary

Fields

Modifier and Type	Field	Description
static ApiOperationMatch	MISSING_PATH	The searched path is not defined in the API definition.
static ApiOperationMatch	NOT_ALLOWED_OPERATION	The searched path is defined in the API definition, but the HTTP method is not allowed.

Constructor Summary

Constructors

Constructor	Description
ApiOperationMatch(ApiOperation apiOperation)	If and only if a ApiOperation was found this ApiOperationMatch contains it.

Method Summary

Modifier and Type	Method	Description
ApiOperation	getApiOperation()
boolean	isOperationAllowed()
boolean	isPathFound()

Methods inherited from class java.lang.Object

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

Field Details

MISSING_PATH

public static ApiOperationMatch MISSING_PATH

The searched path is not defined in the API definition.

NOT_ALLOWED_OPERATION

public static ApiOperationMatch NOT_ALLOWED_OPERATION

The searched path is defined in the API definition, but the HTTP method is not allowed.

Constructor Details

ApiOperationMatch

public ApiOperationMatch(@Nonnull
 ApiOperation apiOperation)

If and only if a ApiOperation was found this ApiOperationMatch contains it.

Parameters:

apiOperation - the found, matching ApiOperation

Method Details

isPathFound

public boolean isPathFound()

Returns:

if a matching path was found

isOperationAllowed

public boolean isOperationAllowed()

Returns:

if the operation is allowed on the matched path

getApiOperation

public ApiOperation getApiOperation()

Returns:

the ApiOperation on the matched path and operation