validation/src/main/java/org/apache/tamaya/validation/spi/AbstractValidator.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 createObject 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.tamaya.validation.spi;

import org.apache.tamaya.Configuration;
import org.apache.tamaya.TypeLiteral;
import org.apache.tamaya.spi.PropertyValue;
import org.apache.tamaya.validation.ValidationCheck;

import java.util.ArrayList;
import java.util.List;

/**
 * Base class for a validator.
 */
public abstract class AbstractValidator implements ConfigValidator {

    /** The target key to validate. */
    private String key;
    /** The optional description. */
    private String description;
    /** The required flag. */
    private boolean required;

    /**
     * Internal constructor.
     * @param key the target configuration key, not null.
     * @param required true, if the value/validation must be successful.
     * @param description the description, not null.
     */
    protected AbstractValidator(String key, boolean required, String description) {
        this.required = required;
        this.description = description;
    }

    /**
     * Get the area or paramter key.
     * @return
     */
    public String getKey() {
        return key;
    }

    /**
     * Get the description of the validation.
     * @return the description.
     */
    public String getDescription() {
        return description;
    }

    /**
     * Checks if the validation will declare an error if not met.
     * @return true, if the validation must not fail.
     */
    public boolean isRequired() {
        return required;
    }

    @Override
    public List<ValidationCheck> validate(Configuration config) {
        List<ValidationCheck> result = new ArrayList<>(1);
        List<PropertyValue> configValues = config.get(key, new TypeLiteral<List<PropertyValue>>());
        if (configValues.isEmpty() && required) {
            result.add(ValidationCheck.createMissing(this, "Key " + key +" must be present"));
        }else{
            validateValues(configValues, result);
        }
        return result;
    }

    /**
     * Internal method to override.
     * @param configValues the config values read in order of precedence.
     * @param result the result list, where the validation checks done should be added.
     */
    protected abstract void validateValues(List<PropertyValue> configValues, List<ValidationCheck> result);

    @Override
    public String toString() {
        StringBuilder b = new StringBuilder();
        b.append(getClass().getSimpleName()).append("{\n");
        if (isRequired()) {
            b.append("  required: ").append(isRequired()).append('\n');
        }
        b.append("  key: ").append(key).append('\n');
        b.append("  description: ").append(description).append("\n}\n");
        return b.toString();
    }

}