WharfResolverMarshaller.java

/*
 *
 *  Copyright (C) 2010 JFrog Ltd.
 *
 *  Licensed 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.jfrog.wharf.ivy.marshall.api;

import org.jfrog.wharf.ivy.model.WharfResolverMetadata;

import java.io.File;
import java.util.Set;

/**
 * @author Tomer Cohen
 */
public interface WharfResolverMarshaller {

    /**
     * Save the wharf resolver meatadatas as a serialized object.
     *
     * @param baseDir                The basedir of where to store the serialized file.
     * @param wharfResolverMetadatas The object to store.
     */
    public void save(File baseDir, Set<WharfResolverMetadata> wharfResolverMetadatas);

    /**
     * Get the wharf metadatas as a de-serialized object.
     *
     * @param baseDir The base dir that contains the serialized file that represents the object.
     * @return The de-serialised object.
     */
    public Set<WharfResolverMetadata> getWharfMetadatas(File baseDir);
}