/*
 * Copyright (c) 2018, 2019, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.graalvm.component.installer.model;

import java.io.IOException;
import java.util.Map;
import java.util.Set;

Serialization of ComponentRegistry. /**
 * Serialization of {@link ComponentRegistry}.
 */
public interface ComponentStorage {
    
Loads list of components.
Throws:
IOException – when I/O fails
Returns:
set of component IDs/**
     * Loads list of components.
     * 
     * @return set of component IDs
     * @throws IOException when I/O fails
     */
    Set<String> listComponentIDs() throws IOException;

    
Loads component files into its metadata.
Params:
ci – the component metadata
Throws:
IOException – on I/O errors
Returns:
the modified ComponentInfo/**
     * Loads component files into its metadata.
     * 
     * @param ci the component metadata
     * @return the modified ComponentInfo
     * @throws IOException on I/O errors
     */
    ComponentInfo loadComponentFiles(ComponentInfo ci) throws IOException;

    
Deserializes Component's metadata.
Params:
id – component ID
Throws:
IOException – on I/O errors
Returns:
matching ComponentInfo instances/**
     * Deserializes Component's metadata.
     * 
     * @param id component ID
     * @return matching ComponentInfo instances
     * @throws IOException on I/O errors
     */
    Set<ComponentInfo> loadComponentMetadata(String id) throws IOException;

    Map<String, String> loadGraalVersionInfo();

}