Skip to content

Commit

Permalink
Fixed multiple javadoc warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
EricWittmann committed Jan 9, 2025
1 parent 1a613f2 commit d8b6262
Show file tree
Hide file tree
Showing 39 changed files with 4 additions and 112 deletions.
2 changes: 1 addition & 1 deletion src/main/java/io/apicurio/datamodels/Library.java
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
* The most common entry points into using the data models library. Provides convenience methods
* for performing common actions such as i/o, visiting, and validation.
* @author eric.wittmann@gmail.com
* @author Jakub Senko <jsenko@redhat.com>
* @author jsenko@redhat.com
*/
public class Library {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* A command used to modify the simple property of a node. Should not be used
* to modify complex (object) properties, only simple property types like
* string, boolean, number, etc. This differs from {@link ChangePropertyCommand}
* in that it can be constructed from a {@link NodePath} rather than a {@link Node}
* in that it can be constructed from a {@link NodePath} rather than a {@link io.apicurio.datamodels.models.Node}
* and therefore can be used in {@link AggregateCommand} use-cases where there is
* a Create followed by a SetProperty.
*
Expand All @@ -22,7 +22,7 @@ public SetPropertyCommand() {
}

/**
* C'tor.
* Constructor.
*/
public SetPropertyCommand(NodePath nodePath, String property, T newValue) {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@
*/
public class LocalReferenceResolver implements IReferenceResolver {

/**
* @see io.apicurio.datamodels.core.util.IReferenceResolver#resolveRef(java.lang.String, io.apicurio.datamodels.core.models.Node)
*/
@SuppressWarnings("rawtypes")
@Override
public Node resolveRef(String $ref, Node from) {
Expand Down
2 changes: 0 additions & 2 deletions src/main/java/io/apicurio/datamodels/refs/Reference.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
/**
* Encapsulates a reference string in OpenAPI/AsyncAPI schema,
* for easier manipulation and parsing.
*
* @author Jakub Senko <jsenko@redhat.com>
*/
public class Reference {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@
*/
public class DefaultSeverityRegistry implements IValidationSeverityRegistry {

/**
* @see io.apicurio.datamodels.core.validation.IValidationSeverityRegistry#lookupSeverity(io.apicurio.datamodels.core.validation.ValidationRuleMetaData)
*/
@Override
public ValidationProblemSeverity lookupSeverity(ValidationRuleMetaData rule) {
if (rule.specMandated) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,6 @@ protected String getDefinitionName(Node node) {
* Returns the name of an encoding. This can only be determined using the traversal
* context because the encoding name is the key for this encoding in the Map of
* encodings for a media type.
* @param pathItem
*/
protected String getEncodingName(OpenApiEncoding encoding) {
return getMappedNodeName(encoding);
Expand All @@ -227,7 +226,6 @@ protected String getPathTemplate(OpenApiPathItem pathItem) {

/**
* Returns the status code of the given response.
* @param pathItem
*/
protected String getStatusCode(OpenApiResponse response) {
if (isDefinition(response)) {
Expand All @@ -239,7 +237,6 @@ protected String getStatusCode(OpenApiResponse response) {

/**
* Returns the operation method (get, put, post, etc) for the given operation.
* @param pathItem
*/
protected String getOperationMethod(Operation operation) {
return (String) this.traversalContext.getMostRecentStep().getValue();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,6 @@ public List<ValidationRuleMetaData> getAllRules() {

/**
* Gets the actual rule instances (visitors) that should be applied to the given document.
* @param document
*/
public List<ValidationRule> getRulesFor(ModelType type) {
List<ValidationRule> rval = new ArrayList<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,6 @@ public List<ValidationProblem> getValidationProblems() {
return this.problems;
}

/**
* @see io.apicurio.datamodels.core.validation.IValidationProblemReporter#report(io.apicurio.datamodels.core.validation.ValidationRuleMetaData, io.apicurio.datamodels.core.models.Node, java.lang.String, java.lang.String)
*/
@Override
public void report(ValidationRuleMetaData ruleInfo, Node node, String property, String message) {
ValidationProblemSeverity severity = this.severityRegistry.lookupSeverity(ruleInfo);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public OasInvalidExternalDocsUrlRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitExternalDocumentation(io.apicurio.datamodels.core.models.common.ExternalDocumentation)
*/
@Override
public void visitExternalDocumentation(ExternalDocumentation node) {
if (hasValue(node.getUrl())) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@ public OasInvalidOpenIDConnectUrlRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSecurityScheme(io.apicurio.datamodels.core.models.common.SecurityScheme)
*/
@Override
public void visitSecurityScheme(SecurityScheme node) {
if (node.root().modelType() == ModelType.OPENAPI30) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public OasInvalidOperationDescriptionRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitOperation(io.apicurio.datamodels.core.models.common.Operation)
*/
@Override
public void visitOperation(Operation node) {
if (hasValue(node.getDescription())) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,6 @@ public OasInvalidOperationProducesRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitOperation(io.apicurio.datamodels.core.models.common.Operation)
*/
@Override
public void visitOperation(Operation node) {
OpenApi20Operation op = (OpenApi20Operation) node;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public OasInvalidParameterDescriptionRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitParameter(io.apicurio.datamodels.core.models.common.Parameter)
*/
@Override
public void visitParameter(Parameter node) {
if (hasValue(node.getDescription())) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,6 @@ public OasInvalidPathItemDescriptionRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitPathItem(io.apicurio.datamodels.openapi.models.OasPathItem)
*/
@Override
public void visitPathItem(OpenApiPathItem node) {
String description = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public OasInvalidSchemaItemsDefaultValueRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitItems(io.apicurio.datamodels.openapi.v2.models.OpenApi20Items)
*/
@Override
public void visitItems(OpenApi20Items node) {
if (hasValue(node.getDefault())) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,6 @@ public OasInvalidSecuritySchemeAuthUrlRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSecurityScheme(io.apicurio.datamodels.core.models.common.SecurityScheme)
*/
@Override
public void visitSecurityScheme(SecurityScheme node) {
OpenApi20SecurityScheme scheme = (OpenApi20SecurityScheme) node;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,6 @@ public OasInvalidSecuritySchemeTokenUrlRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSecurityScheme(io.apicurio.datamodels.core.models.common.SecurityScheme)
*/
@Override
public void visitSecurityScheme(SecurityScheme node) {
OpenApi20SecurityScheme scheme = (OpenApi20SecurityScheme) node;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public OasInvalidServerVariableDescriptionRule(ValidationRuleMetaData ruleInfo)
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitServerVariable(io.apicurio.datamodels.core.models.common.ServerVariable)
*/
@Override
public void visitServerVariable(ServerVariable node) {
if (hasValue(node.getDescription())) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public OasInvalidXmlNamespaceUrlRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitXML(io.apicurio.datamodels.openapi.models.OasXML)
*/
@Override
public void visitXML(OpenApiXML node) {
if (hasValue(node.getNamespace())) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,6 @@ public OasInvalidSecuritySchemeReferenceRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSecurityScheme(io.apicurio.datamodels.core.models.common.SecurityScheme)
*/
@Override
public void visitSecurityScheme(SecurityScheme node) {
if (node.root().modelType() == ModelType.OPENAPI30 || node.root().modelType() == ModelType.OPENAPI31) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ public OasInvalidSchemaArrayItemsRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSchema(io.apicurio.datamodels.core.models.common.Schema)
*/
@Override
public void visitSchema(Schema node) {
Schema items = (Schema) NodeUtil.getNodeProperty(node, "items");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public OasInvalidSchemaTypeValueRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSchema(io.apicurio.datamodels.core.models.common.Schema)
*/
@Override
public void visitSchema(Schema node) {
getTypes(node, (types, allowedTypes) ->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,6 @@ public OasInvalidSecurityReqScopesRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSecurityRequirement(io.apicurio.datamodels.core.models.common.SecurityRequirement)
*/
@Override
public void visitSecurityRequirement(SecurityRequirement node) {
List<String> snames = node.getItemNames();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,6 @@ private SecurityScheme findSecurityScheme(OpenApiDocument document, String schem
return null;
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSecurityRequirement(io.apicurio.datamodels.core.models.common.SecurityRequirement)
*/
@Override
public void visitSecurityRequirement(SecurityRequirement node) {
List<String> allowedTypes = new ArrayList<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,6 @@ private List<String> parseServerTemplate(String serverTemplate) {
return vars;
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitServerVariable(io.apicurio.datamodels.core.models.common.ServerVariable)
*/
@Override
public void visitServerVariable(ServerVariable node) {
String varName = getMappedNodeName(node);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,6 @@ public OasUnexpectedArrayCollectionFormatRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitItems(io.apicurio.datamodels.openapi.v2.models.OpenApi20Items)
*/
@Override
public void visitItems(OpenApi20Items node) {
if (hasValue(node.getCollectionFormat())) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ public MissingLicenseNameRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitLicense(io.apicurio.datamodels.core.models.common.License)
*/
@Override
public void visitLicense(License node) {
this.requireProperty(node, "name", map());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ public MissingOpenIdConnectSecuritySchemeConnectUrlRule(ValidationRuleMetaData r
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSecurityScheme(io.apicurio.datamodels.core.models.common.SecurityScheme)
*/
@Override
public void visitSecurityScheme(SecurityScheme node) {
this.requirePropertyWhen(node, "openIdConnectUrl", "type", "openIdConnect", map());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ public MissingOperationDescriptionRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitOperation(io.apicurio.datamodels.core.models.common.Operation)
*/
@Override
public void visitOperation(Operation node) {
this.requireProperty(node, "description", map());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,6 @@ public MissingSecuritySchemeTypeRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSecurityScheme(io.apicurio.datamodels.core.models.common.SecurityScheme)
*/
@Override
public void visitSecurityScheme(SecurityScheme node) {
if (hasValue(NodeUtil.getProperty(node, "$ref"))) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,6 @@ public MissingServerTemplateUrlRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitServer(io.apicurio.datamodels.core.models.common.Server)
*/
@Override
public void visitServer(Server node) {
this.requireProperty(node, "url", map());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ public OasMissingApiInformationRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitDocument(io.apicurio.datamodels.core.models.Document)
*/
@Override
public void visitDocument(Document node) {
this.requireProperty(node, "info", map());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ public OasMissingExternalDocumentationUrlRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitExternalDocumentation(io.apicurio.datamodels.core.models.common.ExternalDocumentation)
*/
@Override
public void visitExternalDocumentation(ExternalDocumentation node) {
this.requireProperty(node, "url", map());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public OasMissingOpenApiPropertyRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitDocument(io.apicurio.datamodels.core.models.Document)
*/
@Override
public void visitDocument(Document node) {
ModelType mt = node.root().modelType();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@ public OasMissingParameterTypeRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitParameter(io.apicurio.datamodels.core.models.common.Parameter)
*/
@Override
public void visitParameter(Parameter node) {
if (hasValue(NodeUtil.getNodeProperty(node, "$ref"))) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ public OasMissingSchemaArrayInformationRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitSchema(io.apicurio.datamodels.core.models.common.Schema)
*/
@Override
public void visitSchema(Schema node) {
this.requirePropertyWhen(node, "items", "type", "array", map());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ public OasMissingServerVarDefaultValueRule(ValidationRuleMetaData ruleInfo) {
super(ruleInfo);
}

/**
* @see io.apicurio.datamodels.combined.visitors.CombinedAllNodeVisitor#visitServerVariable(io.apicurio.datamodels.core.models.common.ServerVariable)
*/
@Override
public void visitServerVariable(ServerVariable node) {
String variableName = getMappedNodeName(node);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* A composite visitor base class useful for any data model type.
*
* @author eric.wittmann@gmail.com
* @author Jakub Senko <jsenko@redhat.com>
* @author jsenko@redhat.com
*/
public class CompositeAllNodeVisitor extends AllNodeVisitor {

Expand Down
Loading

0 comments on commit d8b6262

Please sign in to comment.