core/src/main/java/org/apache/myfaces/extensions/validator/core/metadata/extractor/ComponentMetaDataExtractorFactory.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.metadata.extractor;

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

import java.util.Map;

/**
 * The interface for all factories which create
 * {@link org.apache.myfaces.extensions.validator.core.metadata.extractor.MetaDataExtractor MetaDataExtractors}.
 * 
 * @since 1.x.1
 */
@UsageInformation(UsageCategory.API)
public interface ComponentMetaDataExtractorFactory
{
    /**
     * Creates a stateless extractor which extracts meta-data.
     * The factory should cache the result instance for performance reasons.
     *
     * @return a stateless extractor which extracts meta-data
     */
    MetaDataExtractor create();

    /**
     * Creates a stateless extractor which extracts meta-data.
     * The factory should cache the result instance for performance reasons.
     *
     * @param properties Properties which should be added to the resulting
     * {@link org.apache.myfaces.extensions.validator.core.property.PropertyInformation} -
     * e.g. meta-information about the current validation module.
     *
     * @return a stateless extractor which extracts meta-data
     */
    MetaDataExtractor createWith(Map<String, Object> properties);
}