sandbox/model/src/main/java/org/apache/tamaya/model/Validated.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.tamaya.model;

import org.apache.tamaya.Configuration;

import java.util.Collection;

/**
 * Basis structure describing a validated item, by default a parameter or a section.
 */
public interface Validated {
    /**
     * Get the item's type.
     *
     * @return the type, never null.
     */
    String getType();

    /**
     * Get the item's fully qualified name. This name is - in combination with the {@link getType()} - unique.
     */
    String getName();

    /**
     * Get an optional description of the item, using the default locale.
     *
     * @return the description required, or null.
     */
    String getDescription();

    /**
     * Validates the item and all its children against the current configuration.
     *
     * @return the validation results, never null.
     */
    Collection<ConfigValidationResult> validate();

    /**
     * Validates the item and all its children against the given configuration.
     *
     * @param config the configuration to be validated against, not null.
     * @return the validation results, never null.
     */
    Collection<ConfigValidationResult> validate(Configuration config);

}