nl.vpro.api.rs.subtitles.AbstractSubtitlesWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of subtitles-domain Show documentation

Subtitles are related to media, but are implemented completely parallel. Classes to contain, parse, and assemble subtitle objects are here.

The newest version!

package nl.vpro.api.rs.subtitles;

import java.io.IOException;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Iterator;

import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.ext.MessageBodyWriter;

import nl.vpro.domain.Changeables;
import nl.vpro.domain.subtitles.Cue;
import nl.vpro.domain.subtitles.Subtitles;
import nl.vpro.domain.subtitles.SubtitlesFormat;
import nl.vpro.domain.subtitles.SubtitlesUtil;
import nl.vpro.poms.shared.Headers;

/**
 * @author Michiel Meeuwissen
 * @since 5.1
 */
abstract class AbstractSubtitlesWriter implements MessageBodyWriter {

    public static final String OFFSET_HEADER = Headers.NPO_SUBTITLES_OFFSET_HEADER;

    private final MediaType mediaType;
    private final String extension;

    public AbstractSubtitlesWriter(SubtitlesFormat format) {
        this.mediaType = MediaType.valueOf(format.getMediaType());
        this.extension = format.getExtension();
    }

    @Override
    public boolean isWriteable(Class type, Type genericType, Annotation[] annotations, MediaType mediaType) {
        return mediaType.isCompatible(this.mediaType) && Subtitles.class.isAssignableFrom(type);

    }

    @Override
    public long getSize(Subtitles subtitles, Class type, Type genericType, Annotation[] annotations, MediaType mediaType) {
        return -1;
    }

    @Override
    public void writeTo(
        Subtitles subtitles,
        Class type,
        Type genericType,
        Annotation[] annotations,
        MediaType mediaType,
        MultivaluedMap httpHeaders,
        OutputStream entityStream) throws IOException, WebApplicationException {
        Util.headers(subtitles.getId(), httpHeaders, extension);
        Changeables.headers(subtitles, httpHeaders);
        httpHeaders.putSingle(OFFSET_HEADER, subtitles.getOffset() == null ? "GUESSED" : subtitles.getOffset().toString());
        stream(subtitles, entityStream);
    }


    protected Iterator iterate(Subtitles subtitles, boolean guessOffset) {
        return SubtitlesUtil.iterator(subtitles, guessOffset);
    }
    abstract protected void stream(Subtitles subtitles, OutputStream entityStream) throws IOException;


}