core/src/main/java/org/apache/myfaces/extensions/validator/core/initializer/configuration/StaticConfiguration.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.myfaces.extensions.validator.core.initializer.configuration;

import org.apache.myfaces.extensions.validator.internal.UsageCategory;
import org.apache.myfaces.extensions.validator.internal.UsageInformation;

import java.util.List;

/**
 * Allows to provide static configurations (mappings).
 * The config format depends on the implementation.
 * 
 * @since 1.x.1
 */
@UsageInformation(UsageCategory.API)
public interface StaticConfiguration<T, R>
{
    /**
     * Specify the location where the configuration can be found.
     *
     * @param path file location of the configuration.
     */
    void setSourceOfMapping(String path);

    /**
     * Returns all config entries found in the specified config.
     *
     * @return List of configuration entries.
     */
    List<StaticConfigurationEntry<T, R>> getMapping();
}