/*
* Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Nuxeo - initial API and implementation
*
*/
package org.eclipse.ecr.convert.extension;
import java.io.Serializable;
import java.util.Map;
import org.eclipse.ecr.convert.api.ConversionException;
import org.eclipse.ecr.convert.cache.CachableBlobHolder;
import org.eclipse.ecr.core.api.blobholder.BlobHolder;
/**
* Interface that must be implemented by any contributer Converter class.
* <p>
* There is only one instance of each contributed converter class: that means
* that the implementation must be thread-safe.
*
* @author tiry
*/
public interface Converter {
/**
* Initializes the Converter.
* <p>
* This can be used to retrieve some configuration information from the XMap
* Descriptor.
*/
void init(ConverterDescriptor descriptor);
/**
* Main method to handle the real Conversion Job.
* <p>
* Returned {@link BlobHolder} must implement {@link CachableBlobHolder},
* otherwise result won't be cached.
*/
BlobHolder convert(BlobHolder blobHolder,
Map<String, Serializable> parameters) throws ConversionException;
}