001/*
002 * Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the Eclipse Public License v1.0
006 * which accompanies this distribution, and is available at
007 * http://www.eclipse.org/legal/epl-v10.html
008 *
009 * Contributors:
010 *     Nuxeo - initial API and implementation
011 *
012 * $Id: DocumentTransformer.java 29029 2008-01-14 18:38:14Z ldoguin $
013 */
014
015package org.nuxeo.ecm.core.io;
016
017import java.io.IOException;
018
019/**
020 * A document transformer.
021 *
022 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
023 */
024// Not used.
025public interface DocumentTransformer {
026
027    /**
028     * Transforms the given document and returns true to pass to the next transformer or false to exit from the
029     * transformation chain.
030     *
031     * @param doc the document to transform
032     * @return true to continue with the next transformer or false to exit transformation chain
033     */
034    boolean transform(ExportedDocument doc) throws IOException;
035
036}