public abstract class ValidationRule extends CombinedAllNodeVisitor implements IVisitor
Modifier and Type | Class and Description |
---|---|
static class |
ValidationRule.PathSegment
Type encapsulating information about a path segment.
|
Constructor and Description |
---|
ValidationRule(ValidationRuleMetaData ruleInfo)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
protected String[] |
array(String... args)
Creates an array.
|
protected boolean |
equals(Object value1,
Object value2)
Returns true if the two values are equal.
|
protected List<ValidationRule.PathSegment> |
getPathSegments(String pathTemplate)
Finds all occurences of path segment patterns in a path template.
|
protected boolean |
hasValue(Object propertyValue)
Check if the property value exists (is not undefined and is not null).
|
protected boolean |
isDefined(Object propertyValue)
Check if a property was defined.
|
protected boolean |
isNullOrUndefined(Object value)
Check if a value is either null or undefined.
|
protected boolean |
isPathWellFormed(String pathTemplate)
Checks the path template against the regular expression and returns match result.
|
protected boolean |
isValidCommonMark(String propertyValue)
Returns true only if the given value is valid CommonMark style markup.
|
protected boolean |
isValidEmailAddress(String propertyValue)
Returns true only if the given value is a valid email address.
|
protected boolean |
isValidEnumItem(String value,
String[] items)
Returns true if the given value is an item in the enum list.
|
protected boolean |
isValidForType(Object value,
Node node)
Returns true if the given value is valid according to the schema provided.
|
protected boolean |
isValidGFM(String propertyValue)
Returns true only if the given value is valid GFM style markup.
|
protected boolean |
isValidHttpCode(String statusCode)
Returns true if the given status code is a valid HTTP response code.
|
protected boolean |
isValidMimeType(List<String> propertyValue)
Returns true only if the given value is a valid mime-type.
|
protected boolean |
isValidUrl(String propertyValue)
Returns true only if the given value is a valid URL.
|
protected boolean |
isValidUrlTemplate(String propertyValue)
Returns true only if the given value is a valid URL template.
|
protected Map<String,String> |
map(String... args)
Turns a list of args into a map suitable for use as template arguments.
|
protected void |
report(Node node,
String property,
Map<String,String> messageParams)
Called by validation rules to report an error.
|
protected void |
reportIf(boolean condition,
Node node,
String property,
Map<String,String> messageParams)
Reports a validation error if the given condition is true.
|
protected void |
reportIfInvalid(boolean isValid,
Node node,
String property,
Map<String,String> messageParams)
Reports a validation error if the property is not valid.
|
protected void |
reportPathError(Node node,
Map<String,String> messageParams)
Utility function to report path related errors.
|
void |
setReporter(IValidationProblemReporter reporter)
Sets the validation problem reporter.
|
visitAaiParameter, visitAdditionalPropertiesSchema, visitAllOfSchema, visitAnyOfSchema, visitAuthorizationCodeOAuthFlow, visitAuthorizationCodeOAuthFlow, visitCallback, visitCallbackDefinition, visitCallbackPathItem, visitChannelBindings, visitChannelBindingsDefinition, visitChannelItem, visitClientCredentialsOAuthFlow, visitClientCredentialsOAuthFlow, visitComponents, visitContact, visitCorrelationId, visitDefinitions, visitDiscriminator, visitDocument, visitEncoding, visitExample, visitExample, visitExampleDefinition, visitExtension, visitExternalDocumentation, visitHeader, visitHeaderDefinition, visitHeaderItem, visitHeaders, visitImplicitOAuthFlow, visitImplicitOAuthFlow, visitInfo, visitItems, visitItemsSchema, visitLicense, visitLink, visitLinkDefinition, visitLinkParameterExpression, visitLinkRequestBodyExpression, visitLinkServer, visitMediaType, visitMessage, visitMessageBindings, visitMessageBindingsDefinition, visitMessageTrait, visitMessageTraitDefinition, visitNode, visitNotSchema, visitOAuthFlows, visitOAuthFlows, visitOneOfSchema, visitOperation, visitOperationBindings, visitOperationBindingsDefinition, visitOperationTrait, visitOperationTraitDefinition, visitParameter, visitParameterDefinition, visitParameterDefinitions, visitPasswordOAuthFlow, visitPasswordOAuthFlow, visitPathItem, visitPaths, visitPropertySchema, visitRequestBody, visitRequestBodyDefinition, visitResponse, visitResponseDefinition, visitResponseDefinitions, visitResponses, visitSchema, visitSchemaDefinition, visitScopes, visitSecurityDefinitions, visitSecurityRequirement, visitSecurityScheme, visitServer, visitServerBindings, visitServerBindingsDefinition, visitServerVariable, visitTag, visitValidationProblem, visitXML
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
visitContact, visitDocument, visitExtension, visitExternalDocumentation, visitInfo, visitLicense, visitOperation, visitParameter, visitParameterDefinition, visitSchema, visitSchemaDefinition, visitSecurityRequirement, visitSecurityScheme, visitTag, visitValidationProblem
public ValidationRule(ValidationRuleMetaData ruleInfo)
ruleInfo
- public void setReporter(IValidationProblemReporter reporter)
reporter
- protected void report(Node node, String property, Map<String,String> messageParams)
node
- property
- messageParams
- protected void reportIfInvalid(boolean isValid, Node node, String property, Map<String,String> messageParams)
isValid
- node
- property
- messageParams
- protected void reportIf(boolean condition, Node node, String property, Map<String,String> messageParams)
condition
- node
- property
- messageParams
- protected void reportPathError(Node node, Map<String,String> messageParams)
node
- messageParams
- protected boolean isDefined(Object propertyValue)
propertyValue
- protected boolean hasValue(Object propertyValue)
propertyValue
- protected boolean isPathWellFormed(String pathTemplate)
pathTemplate
- protected List<ValidationRule.PathSegment> getPathSegments(String pathTemplate)
pathTemplate
- protected boolean isNullOrUndefined(Object value)
value
- protected boolean isValidUrl(String propertyValue)
propertyValue
- protected boolean isValidUrlTemplate(String propertyValue)
propertyValue
- protected boolean isValidGFM(String propertyValue)
propertyValue
- protected boolean isValidCommonMark(String propertyValue)
propertyValue
- protected boolean isValidEmailAddress(String propertyValue)
propertyValue
- protected boolean isValidMimeType(List<String> propertyValue)
propertyValue
- protected boolean isValidEnumItem(String value, String[] items)
value
- items
- protected boolean isValidForType(Object value, Node node)
value
- node
- protected boolean isValidHttpCode(String statusCode)
statusCode
- protected Map<String,String> map(String... args)
Map
two mappings.Copyright © 2021 Red Hat. All rights reserved.