validation/src/main/java/org/apache/tamaya/validation/spi/AreaValidator.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.doc.DocumentedArea;
import org.apache.tamaya.functions.ConfigurationFunctions;
import org.apache.tamaya.validation.ValidationCheck;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Default configuration Model for a configuration parameter.
 */
public class AreaValidator implements ConfigValidator {

    /** The fully qualified parameter name. */
    private String name;
    /** The optional description. */
    private String description;
    /** The min cardinality. */
    private int minCardinality;
    /** The max cardinality. */
    private int maxCardinality;
    /** The owner instance, not null. */
    private Object owner;
    /** The parameter's target type. */
    private Class<?> type;

    /**
     * Create a new property validator.
     * @param documentedArea the property docs, not null.
     */
    public AreaValidator(DocumentedArea documentedArea) {
        this.name = Objects.requireNonNull(documentedArea.getBasePaths().iterator().next());
        this.description = documentedArea.getDescription();
        this.minCardinality = documentedArea.getMinCardinality();
        this.maxCardinality = documentedArea.getMaxCardinality();
        this.owner = documentedArea;
        this.type = documentedArea.getValueType();
    }

    /**
     * Create a new property validator.
     * @param builder the builder, not null.
     */
    private AreaValidator(Builder builder) {
        this.name = Objects.requireNonNull(builder.name);
        this.description = builder.description;
        this.minCardinality = builder.minCardinality;
        this.maxCardinality = builder.maxCardinality;
        this.owner = builder.owner;
        this.type = builder.type;
    }


    @Override
    public List<ValidationCheck> validate(Configuration config) {
        List<ValidationCheck> result = new ArrayList<>(1);
        Configuration section = config.map(ConfigurationFunctions.section(name));
        int size = section.getProperties().size();
        String baseText = description;
        if(baseText==null){
            baseText = "Validation failure for area '" + name + "': ";
        }else{
            baseText = baseText + " Validation failure: ";
        }
        if(minCardinality!=0 && minCardinality>size){
            result.add(ValidationCheck.createError(this, baseText + "Min cardinality required: " + minCardinality +", was: " + size));
        }
        if(maxCardinality!=0 && maxCardinality<size){
            result.add(ValidationCheck.createError(this, baseText + "Max cardinality exceeded: " + maxCardinality +", was: " + size));
        }
        return result;
    }

    @Override
    public String toString() {
        StringBuilder b = new StringBuilder();
        b.append(type).append(": ").append(name);
        if (minCardinality>0) {
            b.append(", min: ").append(minCardinality);
        }
        if (maxCardinality>0) {
            b.append(", max: ").append(maxCardinality);
        }
        return b.toString();
    }

    /**
     * Creates a new Builder instance.
     * @param owner the owner name, not null.
     * @param name the fully qualified parameter name.
     * @return a new builder, never null.
     */
    public static Builder builder(String owner, String name) {
        return new Builder(owner, name);
    }

    /**
     * Creates a new ConfigModel
     * @param owner the owner name, not null.
     * @param name the fully qualified parameter name.
     * @param required the required flag.
     * @return the new ConfigModel instance.
     */
    public static AreaValidator of(Object owner, String name, boolean required) {
        return new Builder(name, owner).setRequired().build();
    }

    /**
     * Creates a new ConfigModel
     * @param owner the owner name, not null.
     * @param name the fully qualified parameter name.
     * @param required the required flag.
     * @return the new ConfigModel instance.
     */
    public static AreaValidator of(String owner, String name, boolean required) {
        return new Builder(owner, name).setRequired().build();
    }

    /**
     * Creates a new ConfigModel
     * @param owner the owner name, not null.
     * @param name the fully qualified parameter name.
     * @param min the minimal cardinality.
     * @param max the maximal cardinality.
     * @return the new ConfigModel instance.
     */
    public static AreaValidator of(String owner, String name, int min, int max) {
        return new Builder(owner, name).setMinCardinality(min).setMaxCardinality(max).build();
    }

    /**
     * Creates a new ConfigModel. The parameter will be defined as optional.
     * @param owner the owner name, not null.
     * @param name the fully qualified parameter name.
     * @return the new ConfigModel instance.
     */
    public static AreaValidator of(String owner, String name) {
        return new Builder(owner, name).build();
    }


    /**
     * A new Builder for creating ParameterModel instances.
     */
    public static class Builder {
        /** The parameter's target type. */
        private Class<?> type;
        /** The fully qualified parameter name. */
        private String name;
        /** The optional description. */
        private String description;
        /** The min cardinality. */
        private int minCardinality;
        /** The max cardinality. */
        private int maxCardinality;
        /** The validation owner. */
        private Object owner;

        /**
         * Creates a new Builder.
         * @param name the fully qualified parameter name, not null.
         * @param owner the owner name, not null.
         */
        public Builder(String name, Object owner) {
            this.name = Objects.requireNonNull(name);
            this.owner = Objects.requireNonNull(owner);
        }

        /**
         * Sets the target type.
         * @param type the type, not null.
         * @return the Builder for chaining
         */
        public Builder setType(String type) {
            try {
                this.type = Class.forName(type);
            } catch (ClassNotFoundException e) {
                try {
                    this.type = Class.forName("java.ui.lang."+type);
                } catch (ClassNotFoundException e2) {
                    Logger.getLogger(getClass().getName()).log(Level.INFO, "Failed to load parameter type: " + type, e2);
                }
            }
            return this;
        }

        /**
         * Sets the minimum cardinality required.
         * @param minCardinality the minimum cardinality.
         * @return the Builder for chaining
         */
        public Builder setMinCardinality(int minCardinality) {
            this.minCardinality = minCardinality;
            return this;
        }

        /**
         * Sets the maximum cardinality required.
         * @param maxCardinality the maximum cardinality.
         * @return the Builder for chaining
         */
        public Builder setMaxCardinality(int maxCardinality) {
            this.maxCardinality = maxCardinality;
            return this;
        }

        /**
         * Sets the minimum cardinality required to {@code 1}.
         * @return the Builder for chaining
         */
        public Builder setRequired() {
            this.minCardinality = 1;
            this.maxCardinality = 0;
            return this;
        }


        /**
         * Sets the optional description
         * @param description the description
         * @return the Builder for chaining
         */
        public Builder setDescription(String description) {
            this.description = description;
            return this;
        }

        /**
         * Sets the owner name.
         * @param owner the owner name, not null.
         * @return the Builder for chaining
         */
        public Builder setOwner(Object owner) {
            this.owner = Objects.requireNonNull(owner);
            return this;
        }

        /**
         * Sets the fully qualified parameter name.
         * @param name the fully qualified parameter name, not null.
         * @return the Builder for chaining
         */
        public Builder setName(String name) {
            this.name = Objects.requireNonNull(name);
            return this;
        }

        /**
         * Creates a new ConfigModel with the given parameters.
         * @return a new ConfigModel , never null.
         */
        public AreaValidator build() {
            return new AreaValidator(this);
        }
    }
}