it.cnr.iit.jscontact.tools.dto.AddressContextEnum Maven / Gradle / Ivy

Go to download
/*
 *    Copyright (C) 2020  Consiglio Nazionale delle Ricerche
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Affero General Public License as
 *     published by the Free Software Foundation, either version 3 of the
 *     License, or (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Affero General Public License for more details.
 *
 *     You should have received a copy of the GNU Affero General Public License
 *     along with this program.  If not, see .
 */
package it.cnr.iit.jscontact.tools.dto;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonValue;
import it.cnr.iit.jscontact.tools.dto.interfaces.IsExtensibleEnum;
import it.cnr.iit.jscontact.tools.dto.interfaces.VCardTypeDerivedEnum;
import it.cnr.iit.jscontact.tools.dto.utils.EnumUtils;
import lombok.AllArgsConstructor;
import lombok.Getter;

import java.util.HashMap;
import java.util.Map;

/**
 * Enum class mapping the "contexts" map keys of the Address type as defined in section 2.5.1 of [RFC9553].
 *
 * @see Section 2.5.1 of RFC9553
 * @author Mario Loffredo
 */
@AllArgsConstructor
public enum AddressContextEnum implements IsExtensibleEnum, VCardTypeDerivedEnum {

    PRIVATE("private"),
    WORK("work"),
    BILLING("billing"),
    DELIVERY("delivery");

    private final String value;

    @Getter
    @JsonIgnore
    private static final Map aliases = new HashMap() {{
        put("home", PRIVATE);
    }};


    @JsonValue
    public String getValue() {
        return value;
    }

    @JsonCreator
    public static AddressContextEnum getEnum(String value) throws IllegalArgumentException {
        return (value == null) ? null : EnumUtils.getEnum(AddressContextEnum.class, value, aliases);
    }

    @Override
    public String toString() {
        return value;
    }

    /**
     * Returns the vCard 4.0 [RFC6350] TYPE parameter corresponding to the enum value representing the address context.
     *
     * @param context the context
     * @return the vCard 4.0 TYPE parameter value
     * @see RFC6350
     */
    @JsonIgnore
    public static String toVCardTypeParam(AddressContextEnum context) {

        if (context == null)
            return null;

        return EnumUtils.toVCardTypeParam(context);
    }

}