001/*
002 * (C) Copyright 2015 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nicolas Chapurlat <nchapurlat@nuxeo.com>
018 */
019
020package org.nuxeo.ecm.core.io.registry;
021
022import java.io.IOException;
023import java.io.OutputStream;
024import java.lang.reflect.Type;
025
026import javax.ws.rs.core.MediaType;
027
028/**
029 * Interface of Java type to mimetype converter.
030 * <p>
031 * see {@link Marshaller} for more details.
032 * </p>
033 *
034 * @param <EntityType> The managed Java type.
035 * @since 7.2
036 */
037public interface Writer<EntityType> extends Marshaller<EntityType> {
038
039    /**
040     * Writes the entity to out {@link OutputStream} using mediatype format.
041     * <p>
042     * This method implementation can use injected properties.
043     * </p>
044     *
045     * @param entity The entity to marshall.
046     * @param clazz The requested marshalled class.
047     * @param genericType The requested marshalled generic type.
048     * @param mediatype The target mediatype.
049     * @param out The output of this marshaller.
050     * @throws IOException If some error append while writing entity to out.
051     * @since 7.2
052     */
053    public void write(EntityType entity, Class<?> clazz, Type genericType, MediaType mediatype, OutputStream out)
054            throws IOException;
055
056}