src/java/org/apache/ivy/plugins/parser/ModuleDescriptorParser.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
 *
 *      https://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.ivy.plugins.parser;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.text.ParseException;

import org.apache.ivy.core.module.descriptor.Artifact;
import org.apache.ivy.core.module.descriptor.ModuleDescriptor;
import org.apache.ivy.core.module.id.ModuleRevisionId;
import org.apache.ivy.plugins.repository.Resource;

public interface ModuleDescriptorParser {
    ModuleDescriptor parseDescriptor(ParserSettings ivySettings, URL descriptorURL,
            boolean validate) throws ParseException, IOException;

    ModuleDescriptor parseDescriptor(ParserSettings ivySettings, URL descriptorURL,
            Resource res, boolean validate) throws ParseException, IOException;

    /**
     * Convert a module descriptor to an ivy file. This method MUST close the given input stream
     * when job is finished
     *
     * @param is input stream with opened on original module descriptor resource
     * @param res Resource
     * @param destFile File
     * @param md ModuleDescriptor
     * @throws ParseException if something goes wrong
     * @throws IOException if something goes wrong
     */
    void toIvyFile(InputStream is, Resource res, File destFile, ModuleDescriptor md)
            throws ParseException, IOException;

    boolean accept(Resource res);

    /**
     * Return the 'type' of module artifacts this parser is parsing
     *
     * @return the 'type' of module artifacts this parser is parsing
     */
    String getType();

    /**
     * Returns the module metadata artifact corresponding to the given module revision id that this
     * parser parses
     *
     * @param res
     *            the resource for which the module artifact should be returned
     * @param mrid
     *            the module revision id for which the module artifact should be returned
     * @return the module artifact corresponding to the given mrid and resource
     */
    Artifact getMetadataArtifact(ModuleRevisionId mrid, Resource res);
}