nl.vpro.domain.media.Region Maven / Gradle / Ivy

Go to download

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

The basic domain classes for 'media', the core of POMS. Also, the 'update' XML bindings for it. It also contains some closely related domain classes like the enum to contain NICAM kijkwijzer settings.

There is a newer version: 8.3.1

Show newest version

/*
 * Copyright (C) 2012 Licensed under the Apache License, Version 2.0
 * VPRO The Netherlands
 */
package nl.vpro.domain.media;

import lombok.Getter;

import java.net.URI;
import java.util.Optional;

import jakarta.xml.bind.annotation.XmlEnum;

import org.apache.commons.lang3.StringUtils;
import org.meeuw.i18n.countries.Country;
import org.meeuw.xml.bind.annotation.XmlDocumentation;

import com.neovisionaries.i18n.CountryCode;

import nl.vpro.i18n.Displayable;


/**
 * The region as used in {@link GeoRestriction}. The order wants to be from more to less restrictive.
 */
@Getter
@XmlEnum
//@XmlJavaTypeAdapter(value = RegionAdapter.class)
public enum Region implements Displayable, org.meeuw.i18n.regions.Region {

    /**
     * Netherlands
     */
    @XmlDocumentation("Means that this object can only be played in the Netherlands")
    NL("Nederland") {
        @Override
        public Optional getIcon() {
            return Country.of(CountryCode.NL).getIcon();
        }
    },

    /**
     * Netherlands and communities in the Caribbean
     * @since 5.6
     */
    @XmlDocumentation("Nederland plus BES gemeentes")
    NLBES("Nederland en de BES-gemeenten"),

    /**
     * Netherlands and communities in the Caribbean and Curaçao, St. Maarten and Aruba
     * @since 5.6
     */
    @XmlDocumentation("Nederland plus BES gemeentes plus Curaçao, St. Maarten en Aruba")
    NLALL("Nederland, de BES-gemeenten, Curaçao, St. Maarten en Aruba"),


    /**
     * Belgium, Netherlands and Luxemburg
     * @deprecated Not supported by VMV
     */
    @Deprecated
    @XmlDocumentation("Means that this object can only be played in the Netherlands, Belgium and Luxemburg (This is, as far was we know, not supported by the NPO player). It may be supported by redirect service though.")
    BENELUX("Benelux") {
        @Override
        public boolean display() {
            return true;
        }
    },

    /**
     * Europe
     * @since 5.6
     */
    @XmlDocumentation("Means that this object can only be played in Europe")
    EUROPE("Europa") {

    },

    /**
     * European Union incl. BES-gemeentes, Curaçao, Sint Maarten en Aruba
     * @since 5.6
     */
    @XmlDocumentation("European Union incl. BES-gemeentes, Curaçao, Sint Maarten en Aruba")
    EU("De EU inclusief de BES-gemeenten, Curaçao, Sint Maarten en Aruba") {
        @Override
        public Optional getIcon() {
            return Country.of(CountryCode.EU).getIcon();
        }
    },

    /**
     * It can be handy to have a region value that effectively doesn't restrict anything. This way there is no need for
     * null checks and things like that.
     * @since 7.6
     */
    @XmlDocumentation("No georestriction")
    UNIVERSE("Overal te zien") {
        @Override
        public boolean display() {
            return false;
        }
    }
    ;

    public static final Region[] RESTRICTED_REGIONS = {NL, NLBES, NLALL, EUROPE, EU};


    private final String displayName;

    Region(String displayName) {
        this.displayName = displayName;
    }

    public static Region valueOfOrNull(String v) {
        try {
            return valueOfOrNullOrIllegalArgument(v);
        } catch (IllegalArgumentException iae) {
            return null;
        }
    }

    public static Region valueOfOrNullOrIllegalArgument(String v) {
        if (StringUtils.isEmpty(v)) {
            return null;
        }
        if (v.equalsIgnoreCase("EUROPA")) {
            return EUROPE;
        }
        return valueOf(v);

     }

    @Override
    public String getCode() {
        return name();
    }

    @Override
    public Type getType() {
        return Type.UNDEFINED;
    }

    @Override
    public String getName() {
        return displayName;
    }

    @Override
    public Optional getIcon() {
        return Displayable.super.getIcon();
    }
}