org.yamcs.yarch.ProtobufDatabase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yamcs-core Show documentation

There is a newer version: 5.10.9

package org.yamcs.yarch;

import java.io.IOException;

import com.google.protobuf.Message;

/**
 * A database that allows to store and retrieve protobuf messages.
 */
public interface ProtobufDatabase {

    /**
     * Save a protobuf message. If a message is already saved under the given id, it is overwritten.
     * 
     * @param id
     *            the identifier
     * @param message
     *            the protobuf message
     */
    void save(String id, Message message) throws IOException;

    /**
     * Retrieves a protobuf message for a specific id.
     * 
     * @param id
     *            the identifier to search for
     * @param messageClass
     *            the expected message class
     * 
     * @return the found message, or {@code null}
     */
     T get(String id, Class messageClass) throws IOException;

    /**
     * Delete a protobuf message for a specific id.
     * 
     * @param id
     *            the identifier to search for
     * 
     * @return whether a record was found and deleted.
     */
    boolean delete(String id) throws IOException;
}