io.apicurio.datamodels.core.validation.rules.invalid.name

Class OasInvalidPropertyNameRule

java.lang.Object

io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor

io.apicurio.datamodels.core.validation.ValidationRule

io.apicurio.datamodels.core.validation.rules.invalid.name.OasInvalidPropertyNameRule

All Implemented Interfaces:

IAai20Visitor, IAaiVisitor, IVisitor, IOas20Visitor, IOas30Visitor, IOasVisitor

Direct Known Subclasses:

OasDuplicatePathSegmentRule, OasEmptyPathSegmentRule, OasIdenticalPathTemplateRule, OasInvalidCallbackDefinitionNameRule, OasInvalidExampleDefinitionNameRule, OasInvalidHeaderDefinitionNameRule, OasInvalidHttpResponseCodeRule, OasInvalidLinkDefinitionNameRule, OasInvalidParameterDefNameRule, OasInvalidPathSegmentRule, OasInvalidRequestBodyDefinitionNameRule, OasInvalidResponseDefNameRule, OasInvalidSchemaDefNameRule, OasInvalidScopeNameRule, OasInvalidSecuritySchemeNameRule, OasUnmatchedEncodingPropertyRule, OasUnmatchedExampleTypeRule

public abstract class OasInvalidPropertyNameRule
extends ValidationRule

Base class for all Invalid Property Name rules.

Author:

eric.wittmann@gmail.com

Nested Class Summary

Nested classes/interfaces inherited from class io.apicurio.datamodels.core.validation.ValidationRule

ValidationRule.PathSegment

Constructor Summary

Constructors

Constructor and Description
OasInvalidPropertyNameRule(ValidationRuleMetaData ruleInfo) Constructor.

Method Summary

Modifier and Type	Method and Description
protected List<String>	findDuplicateParametersInPath(List<ValidationRule.PathSegment> pathSegments) Finds path segments that are duplicates i.e.
protected List<ValidationRule.PathSegment>	findEmptySegmentsInPath(List<ValidationRule.PathSegment> pathSegments) Finds all occurences of path segments that are empty.
protected boolean	isValidDefinitionName(String name) Returns true if the definition name is valid.
protected boolean	isValidScopeName(String scope) Returns true if the scope name is valid.

Methods inherited from class io.apicurio.datamodels.core.validation.ValidationRule

array, equals, getPathSegments, hasValue, isDefined, isNullOrUndefined, isPathWellFormed, isValidCommonMark, isValidEmailAddress, isValidEnumItem, isValidForType, isValidGFM, isValidHttpCode, isValidMimeType, isValidUrl, isValidUrlTemplate, map, report, reportIf, reportIfInvalid, reportPathError, setReporter

Methods inherited from class io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor

visitAaiParameter, visitAdditionalPropertiesSchema, visitAllOfSchema, visitAnyOfSchema, visitAuthorizationCodeOAuthFlow, visitAuthorizationCodeOAuthFlow, visitCallback, visitCallbackDefinition, visitCallbackPathItem, 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, visitMessageTrait, visitMessageTraitExtendedItem, visitMessageTraitItems, visitNode, visitNotSchema, visitOAuthFlows, visitOAuthFlows, visitOneOfSchema, visitOperation, visitOperationTrait, visitOperationTraitExtendedItem, visitOperationTraitItems, visitParameter, visitParameterDefinition, visitParameterDefinitions, visitPasswordOAuthFlow, visitPasswordOAuthFlow, visitPathItem, visitPaths, visitPropertySchema, visitProtocolInfo, visitRequestBody, visitRequestBodyDefinition, visitResponse, visitResponseDefinition, visitResponseDefinitions, visitResponses, visitSchema, visitSchemaDefinition, visitScopes, visitSecurityDefinitions, visitSecurityRequirement, visitSecurityScheme, visitServer, visitServerVariable, visitTag, visitUnknownTrait, visitValidationProblem, visitXML

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.apicurio.datamodels.core.visitors.IVisitor

visitContact, visitDocument, visitExtension, visitExternalDocumentation, visitInfo, visitLicense, visitOperation, visitParameter, visitParameterDefinition, visitSchema, visitSchemaDefinition, visitSecurityRequirement, visitSecurityScheme, visitTag, visitValidationProblem

Constructor Detail

OasInvalidPropertyNameRule

public OasInvalidPropertyNameRule(ValidationRuleMetaData ruleInfo)

Constructor.

Parameters:

ruleInfo -

Method Detail

isValidDefinitionName

protected boolean isValidDefinitionName(String name)

Returns true if the definition name is valid.

Parameters:

name -

isValidScopeName

protected boolean isValidScopeName(String scope)

Returns true if the scope name is valid.

Parameters:

scope -

findEmptySegmentsInPath

protected List<ValidationRule.PathSegment> findEmptySegmentsInPath(List<ValidationRule.PathSegment> pathSegments)

Finds all occurences of path segments that are empty. i.e. they neither have a prefix nor a path variable within curly braces.

Parameters:

pathSegments -

findDuplicateParametersInPath

protected List<String> findDuplicateParametersInPath(List<ValidationRule.PathSegment> pathSegments)

Finds path segments that are duplicates i.e. they have the same formal name used across multiple segments. For example, in a path like /prefix/{var1}/{var1}, var1 is used in multiple segments.

Parameters:

pathSegments -