001/*
002 *  Copyright 2020 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.repository.data.extractor.xml;
017
018import java.util.Optional;
019
020import org.ametys.runtime.model.type.ElementType;
021
022/**
023 * Retrieves the additional data needed to extract values in an XML document
024 */
025@FunctionalInterface
026public interface XMLValuesExtractorAdditionalDataGetter
027{
028    /**
029     * Retrieves the additional data needed to extract the value at the given path
030     * @param dataPath the data path
031     * @param type the type of the data at the given path 
032     * @return the additional data
033     */
034    public Optional<Object> getAdditionalData(String dataPath, ElementType type);
035}