FileSponge/src/main/lombok/org/warp/filesponge/extra/api/FileURITranslator.java

/*
 *     FileSponge
 *     Copyright (C) 2020 Andrea Cavalli
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program 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 for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

package org.warp.filesponge.extra.api;

import java.util.Optional;
import org.warp.filesponge.value.AlreadyAssignedException;
import org.warp.filesponge.value.FileURI;

/**
 * Translate File URIs to "fileId" and back
 */
public interface FileURITranslator<FURI extends FileURI, FID> {

	Optional<FURI> getURI(FID fileId);

	Optional<FID> getFileId(FURI fileURI);

	/**
	 * @throws AlreadyAssignedException Throw if the uri has another fileId assigned
	 */
	void setFileId(FURI fileURI, FID fileId) throws AlreadyAssignedException;

	Optional<FURI> delete(FID fileId);

	Optional<FID> delete(FURI fileURI);

	void clear();
}