it.cnr.iit.jscontact.tools.dto.NameComponent 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.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 it.cnr.iit.jscontact.tools.dto.deserializers.NameComponentTypeDeserializer;
import it.cnr.iit.jscontact.tools.dto.interfaces.HasType;
import lombok.*;
import lombok.experimental.SuperBuilder;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import java.io.Serializable;

/**
 * Class mapping the NameComponent type as defined in section 2.2.2 of [draft-ietf-calext-jscontact].
 *
 * @author Mario Loffredo
 * @see draft-ietf-calext-jscontact
 */
@JsonPropertyOrder({"@type", "value", "type", "rank"})
@JsonInclude(JsonInclude.Include.NON_NULL)
@SuperBuilder
@Data
@AllArgsConstructor
@NoArgsConstructor
@EqualsAndHashCode(callSuper = false)
public class NameComponent extends AbstractJSContactType implements HasType, Serializable {

    @NotNull
    @Pattern(regexp = "NameComponent", message = "invalid @type value in NameComponent")
    @JsonProperty("@type")
    @Builder.Default
    String _type = "NameComponent";

    @NotNull(message = "value is missing in NameComponent")
    @NonNull
    String value;

    @NotNull(message = "type is missing in NameComponent")
    @NonNull
    @JsonDeserialize(using = NameComponentTypeDeserializer.class)
    NameComponentType type;

    @Min(value = 1, message = "invalid rank in NameComponent - value must be greater or equal than 1")
    Integer rank;

    private boolean isRfc(NameComponentEnum value) {
        return (type.getRfcValue() != null && type.getRfcValue() == value);
    }

    /**
     * Tests if this is a prefix.
     *
     * @return true if this is a prefix, false otherwise
     */
    @JsonIgnore
    public boolean isPrefix() { return isRfc(NameComponentEnum.PREFIX); }
    /**
     * Tests if this is a given name.
     *
     * @return true if this is a given name, false otherwise
     */
    @JsonIgnore
    public boolean isGiven() { return isRfc(NameComponentEnum.GIVEN); }
    /**
     * Tests if this is the surname.
     *
     * @return true if this is the surname, false otherwise
     */
    @JsonIgnore
    public boolean isSurname() { return isRfc(NameComponentEnum.SURNAME); }
    /**
     * Tests if this is a middle name.
     *
     * @return true if this is a middle name, false otherwise
     */
    @JsonIgnore
    public boolean isMiddle() { return isRfc(NameComponentEnum.MIDDLE); }
    /**
     * Tests if this is a suffix.
     *
     * @return true if this is a suffix, false otherwise
     */
    @JsonIgnore
    public boolean isSuffix() { return isRfc(NameComponentEnum.SUFFIX); }
    /**
     * Tests if this is the separator for name components used to build the full name.
     *
     * @return true if this is the separator, false otherwise
     */
    @JsonIgnore
    public boolean isSeparator() { return isRfc(NameComponentEnum.SEPARATOR); }
    /**
     * Tests if this is a custom name component.
     *
     * @return true if this is a custom name component, false otherwise
     */
    @JsonIgnore
    public boolean isExt() { return type.isExtValue(); }

    private static NameComponent rfc(NameComponentEnum rfcValue, String value, Integer rank) {
        return NameComponent.builder()
                .value(value)
                .type(NameComponentType.builder().rfcValue(rfcValue).build())
                .rank(rank)
                .build();
    }
    /**
     * Returns a prefix component of a name.
     *
     * @param value the prefix
     * @return the prefix component
     */
    public static NameComponent prefix(String value) {return rfc(NameComponentEnum.PREFIX, value, null);}
    /**
     * Returns a prefix component of a name.
     *
     * @param value the prefix
     * @param rank the rank
     * @return the prefix component
     */
    public static NameComponent prefix(String value, Integer rank) {return rfc(NameComponentEnum.PREFIX, value, rank);}
    /**
     * Returns a given name component of a name.
     *
     * @param value the given name
     * @return the given name  component
     */
    public static NameComponent given(String value) {return rfc(NameComponentEnum.GIVEN, value, null);}
    /**
     * Returns a given name component of a name.
     *
     * @param value the given name
     * @param rank the rank
     * @return the given name  component
     */
    public static NameComponent given(String value, Integer rank) {return rfc(NameComponentEnum.GIVEN, value, rank);}
    /**
     * Returns a surname component of a name.
     *
     * @param value the surname
     * @return the surname  component
     */
    public static NameComponent surname(String value) {return rfc(NameComponentEnum.SURNAME, value, null);}
    /**
     * Returns a surname component of a name.
     *
     * @param value the surname
     * @param rank the rank
     * @return the surname  component
     */
    public static NameComponent surname(String value, Integer rank) {return rfc(NameComponentEnum.SURNAME, value, rank);}
    /**
     * Returns an additional name component of a name.
     *
     * @param value the middle name
     * @return the middle name  component
     */
    public static NameComponent middle(String value) {return rfc(NameComponentEnum.MIDDLE, value, null);}
    /**
     * Returns an additional name component of a name.
     *
     * @param value the middle name
     * @param rank the rank
     * @return the middle name  component
     */
    public static NameComponent middle(String value, Integer rank) {return rfc(NameComponentEnum.MIDDLE, value, rank);}
    /**
     * Returns a suffix name component of a name.
     *
     * @param value the suffix
     * @return the suffix name  component
     */
    public static NameComponent suffix(String value) {return rfc(NameComponentEnum.SUFFIX, value, null);}
    /**
     * Returns a suffix name component of a name.
     *
     * @param value the suffix
     * @param rank the suffix
     * @return the suffix name  component
     */
    public static NameComponent suffix(String value, Integer rank) {return rfc(NameComponentEnum.SUFFIX, value, rank);}
    /**
     * Returns a separator name component of a name.
     *
     * @param value the separator
     * @return the separator name  component
     */
    public static NameComponent separator(String value) {return rfc(NameComponentEnum.SEPARATOR, value, null);}
    /**
     * Returns a custom component of a name.
     *
     * @param extValue the custom name component
     * @param value the value for the custom name component
     * @param rank the rank value for the custom name component
     * @return the custom component
     */
    public static NameComponent ext(String extValue, String value, Integer rank) {
        return NameComponent.builder()
                .value(value)
                .type(NameComponentType.builder().extValue(V_Extension.toV_Extension(extValue)).build())
                .rank(rank)
                .build();
    }


}