oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ObjectPropertyRequiredValidator.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.servicecomb.toolkit.oasv.validation.api;

import org.apache.commons.lang3.StringUtils;
import org.apache.servicecomb.toolkit.oasv.common.OasObjectPropertyLocation;
import org.apache.servicecomb.toolkit.oasv.common.OasObjectType;

import java.util.List;

import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;

/**
 * Object property should not be null validator
 *
 * @param <T> Objects defined in <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#table-of-contents">OpenAPI Specification</a>
 * @param <P> Property type
 */
public abstract class ObjectPropertyRequiredValidator<T, P> implements OasObjectValidator<T> {

  @Override
  final public List<OasViolation> validate(OasValidationContext context, OasObjectPropertyLocation location,
      T oasObject) {
    if (StringUtils.isNotBlank(get$ref(oasObject))) {
      return emptyList();
    }
    P propertyObject = getPropertyObject(oasObject);
    if (propertyObject == null) {
      OasObjectPropertyLocation propertyLoc = location.property(getPropertyName(), getPropertyType());
      return singletonList(new OasViolation(propertyLoc, ViolationMessages.REQUIRED));
    }
    if (propertyObject != null && String.class.equals(propertyObject.getClass())
        && StringUtils.isBlank((CharSequence) propertyObject)) {
      OasObjectPropertyLocation propertyLoc = location.property(getPropertyName(), getPropertyType());
      return singletonList(new OasViolation(propertyLoc, ViolationMessages.REQUIRED));
    }
    return emptyList();
  }

  protected abstract String get$ref(T oasObject);

  protected abstract P getPropertyObject(T oasObject);

  protected abstract String getPropertyName();

  protected abstract OasObjectType getPropertyType();

}