nl.vpro.domain.subtitles.SubtitlesId 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.

There is a newer version: 8.3.0

Show newest version

package nl.vpro.domain.subtitles;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Getter;
import lombok.Setter;

import java.io.Serial;
import java.io.Serializable;
import java.util.Comparator;
import java.util.Locale;

import javax.xml.XMLConstants;
import javax.xml.bind.annotation.*;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

import nl.vpro.i18n.Locales;
import nl.vpro.xml.bind.LocaleAdapter;

import static nl.vpro.i18n.Locales.DUTCH;

/**
 * @author Michiel Meeuwissen
 * @since 4.7.7
 */
@Setter
@XmlRootElement(name = "id")
@XmlAccessorType(XmlAccessType.NONE)
public class SubtitlesId implements Serializable, Comparable {

    @Serial
    private static final long serialVersionUID = -965983441644838265L;

    @XmlAttribute
    @Getter
    private String mid;

    @XmlAttribute
    @Getter
    private SubtitlesType type = SubtitlesType.CAPTION;

    @XmlAttribute(name = "lang", namespace = XMLConstants.XML_NS_URI)
    @XmlJavaTypeAdapter(LocaleAdapter.class)
    @Getter
    @Schema(implementation = String.class, type = "string")
    private Locale language;

    public static SubtitlesId tt888Caption(String mid) {
        return new SubtitlesId(mid, DUTCH, SubtitlesType.CAPTION);
    }

    public static SubtitlesId of(String mid, Locale language, SubtitlesType type) {
        return new SubtitlesId(mid, language, type);
    }

    public static SubtitlesId of(String stringRep) {
        String[] parts = stringRep.split("\t", 3);
        if (parts.length == 3) {
            return SubtitlesId.builder()
                .mid(parts[0])
                .type(SubtitlesType.valueOf(parts[1]))
                .language(Locales.ofString(parts[2]))
                .build();
        } else {
            throw new IllegalArgumentException("Cannot parse " + stringRep);
        }
    }

    public SubtitlesId()  {

    }

    @lombok.Builder(builderClassName = "Builder")
    public SubtitlesId(String mid, Locale language, SubtitlesType type) {
        this.mid = mid;
        this.language = language;
        if (type != null) {
            this.type = type;
        }
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        SubtitlesId that = (SubtitlesId) o;

        if (!mid.equals(that.mid)) return false;
        if (type != that.type) return false;
        return language.equals(that.language);

    }

    @Override
    public int hashCode() {
        int result = mid.hashCode();
        result = 31 * result + type.hashCode();
        result = 31 * result + language.hashCode();
        return result;
    }

    @Override
    public String toString() {
        return mid + "\t" + type + "\t" + language;
    }

    @Override
    public int compareTo(SubtitlesId o) {
        return Comparator.comparing(SubtitlesId::getMid)
            .thenComparing(SubtitlesId::getType)
            .thenComparing(p->p.getLanguage().toString())
            .compare(this, o);
    }

}