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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jscontact-tools Show documentation
Java tools for JSContact building, validation, serialization/deserialization and conversion from vCard 4.0 (RFC6350) and its transliterations, namely xCard (RFC6351) and jCard (RFC7095).
There is a newer version: 1.0.1
Show newest version
package it.cnr.iit.jscontact.tools.dto;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import it.cnr.iit.jscontact.tools.constraints.BooleanMapConstraint;
import it.cnr.iit.jscontact.tools.dto.annotations.ContainsExtensibleEnum;
import it.cnr.iit.jscontact.tools.dto.deserializers.ContextsDeserializer;
import it.cnr.iit.jscontact.tools.dto.deserializers.PhoneFeaturesDeserializer;
import it.cnr.iit.jscontact.tools.dto.interfaces.HasLabel;
import it.cnr.iit.jscontact.tools.dto.interfaces.IdMapValue;
import it.cnr.iit.jscontact.tools.dto.interfaces.HasContexts;
import it.cnr.iit.jscontact.tools.dto.interfaces.IsIANAType;
import it.cnr.iit.jscontact.tools.dto.serializers.ContextsSerializer;
import it.cnr.iit.jscontact.tools.dto.serializers.PhoneFeaturesSerializer;
import lombok.*;
import lombok.experimental.SuperBuilder;
import org.apache.commons.lang3.ArrayUtils;

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

/**
 * Class mapping the Phone type as defined in section 2.3.3 of [RFC9553].
 *
 * @see Section 2.3.3 of RFC9553
 * @author Mario Loffredo
 */
@JsonPropertyOrder({"@type","number","features","contexts","pref","label"})
@JsonInclude(JsonInclude.Include.NON_NULL)
@SuperBuilder
@Data
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode(callSuper = false)
public class Phone extends AbstractJSContactType implements HasLabel, IdMapValue, IsIANAType, Serializable, HasContexts {

    @Pattern(regexp = "Phone", message="invalid @type value in Phone")
    @JsonProperty("@type")
    @Builder.Default
    String _type = "Phone";
    
    @NotNull(message = "number is missing in Phone")
    @NonNull
    String number;

    @JsonSerialize(using = PhoneFeaturesSerializer.class)
    @JsonDeserialize(using = PhoneFeaturesDeserializer.class)
    @BooleanMapConstraint(message = "invalid Map features in Phone - Only Boolean.TRUE allowed")
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    @ContainsExtensibleEnum(enumClass = PhoneFeatureEnum.class, getMethod = "getFeatures")
    Map features;

    @JsonSerialize(using = ContextsSerializer.class)
    @JsonDeserialize(using = ContextsDeserializer.class)
    @BooleanMapConstraint(message = "invalid Map contexts in Phone - Only Boolean.TRUE allowed")
    @JsonInclude(JsonInclude.Include.NON_EMPTY)
    @ContainsExtensibleEnum(enumClass = ContextEnum.class, getMethod = "getContexts")
    Map contexts;

    @Min(value=1, message = "invalid pref in Phone - value must be greater or equal than 1")
    @Max(value=100, message = "invalid pref in Phone - value must be less or equal than 100")
    Integer pref;

    String label;


    /**
     * Tests if the pheature of this phone is not empty.
     *
     * @return true if the features map is not empty, false otherwise
     */
    public boolean hasFeature() {
        return features != null && !features.isEmpty();
    }

    private boolean asFeature(PhoneFeature feature) {
        return hasFeature() && features.containsKey(feature);
    }

    /**
     * Tests if this phone number is for calling by voice.
     *
     * @return true if this phone number isfor calling by voice, false otherwise
     */
    public boolean asVoice() {
        return asFeature(PhoneFeature.voice());
    }
    /**
     * Tests if this phone number is for sending a fax.
     *
     * @return true if this phone number is for sending a fax, false otherwise
     */
    public boolean asFax() { return asFeature(PhoneFeature.fax()); }
    /**
     * Tests if this phone number is for a pager or a beeper.
     *
     * @return true if phone number is for a pager or a beeper, false otherwise
     */
    public boolean asPager() { return asFeature(PhoneFeature.pager()); }
    /**
     * Tests if this phone number supports video conferencing.
     *
     * @return true if this phone number supports video conferencing, false otherwise
     */
    public boolean asVideo() { return asFeature(PhoneFeature.video()); }
    /**
     * Tests if this phone number is for a cell phone.
     *
     * @return true if this phone number is for a cell phone, false otherwise
     */
    public boolean asMobile() { return asFeature(PhoneFeature.mobile()); }
    /**
     * Tests if this phone number supports text messages (SMS).
     *
     * @return true if this phone number supports text messages, false otherwise
     */
    public boolean asText() { return asFeature(PhoneFeature.text()); }
    /**
     * Tests if this phone number is for a device for people with hearing or speech difficulties.
     *
     * @return true if this phone number is for a device for people with hearing or speech difficulties, false otherwise
     */
    public boolean asTextphone() { return asFeature(PhoneFeature.textphone()); }
    /**
     * Tests if this phone number supports a custom feature.
     *
     * @param extValue the custom feature
     * @return true if this phone number supports a custom purpose, false otherwise
     */
    public boolean asExt(String extValue) { return asFeature(PhoneFeature.ext(extValue)); }

    /**
     * Adds a phone feature to this object.
     *
     * @param feature the phone feature
     */
    public void addFeature(PhoneFeature feature) {
        if (features == null)
            features = new HashMap<>();

        Map clone = new HashMap<>(features);
        clone.put(feature,Boolean.TRUE);
        setFeatures(clone);
    }


    /**
     * This method will be used to get the extended features in the "features" property.
     *
     * @return the extended features in the "features" property
     */
    @JsonIgnore
    public PhoneFeature[] getExtPhoneFeatures() {
        if (getFeatures() == null)
            return null;
        PhoneFeature[] extended = null;
        for(PhoneFeature feature : getFeatures().keySet()) {
            if (feature.isExtValue())
                extended = ArrayUtils.add(extended, feature);
        }

        return extended;
    }

}