io.kestros.commons.structuredslingmodels.validation.ModelValidationService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kestros-structured-sling-models Show documentation

Foundational classes for that can be used across any Sling instance. Includes base model types and model interaction utilities.

There is a newer version: 0.2.5

Show newest version

/*
 * 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 io.kestros.commons.structuredslingmodels.validation;

import io.kestros.commons.structuredslingmodels.BaseSlingModel;
import java.util.ArrayList;
import java.util.List;

/**
 * Baseline ModelValidationService to be extended from.
 */
public abstract class ModelValidationService {

  private BaseSlingModel model;

  private final List basicValidators = new ArrayList<>();
  private final List detailedValidators = new ArrayList<>();

  /**
   * Sets the model that the ValidationService validates against.
   *
   * @param model model to validate against.
   * @param  Model type which extends BaseSlingModel.
   */
  public  void setModel(final T model) {
    this.model = model;
  }

  /**
   * Retrieves the model that the ValidationService validates against.
   *
   * @param  Model type which extends BaseSlingModel.
   * @return The model that the ValidationService validates against.
   */
  public abstract  T getModel();

  /**
   * Registers ModelValidators.
   */
  public abstract void registerBasicValidators();

  /**
   * Registers ModelValidators.
   */
  public abstract void registerDetailedValidators();

  /**
   * The model to validate against, as a generic BaseSlingModel. Should be casted to a specific
   * Model type.
   *
   * @return The model to validate against, as a generic BaseSlingModel.
   */
  public BaseSlingModel getGenericModel() {
    return model;
  }

  /**
   * Add ModelValidator to the current service to be processed when validation is called on the
   * model.
   *
   * @param validator Validator to be added to the ValidationService.
   */
  public void addBasicValidator(final ModelValidator validator) {
    basicValidators.add(validator);
  }

  /**
   * Add ModelValidator to the current service to be processed when detailed validation is called on
   * the model.
   *
   * @param validator Validator to be added to the ValidationService.
   */
  public void addDetailedValidator(final ModelValidator validator) {
    detailedValidators.add(validator);
  }

  /**
   * List of ModelValidators that always run during PostConstruct.
   *
   * @return List of ModelValidators that always run during PostConstruct.
   */
  public List getBasicValidators() {
    return basicValidators;
  }

  /**
   * List of ModelValidators that must be explicitly invoked via doDetailedValidation to run.
   *
   * @return List of ModelValidators that must be explicitly invoked via doDetailedValidation to
   *     run.
   */
  public List getDetailedValidators() {
    return detailedValidators;
  }

}