it.cnr.iit.jscontact.tools.vcard.converters.xcard2jscontact.XCard2JSContact 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

/*
 *    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.vcard.converters.xcard2jscontact;

import ezvcard.VCard;
import it.cnr.iit.jscontact.tools.dto.Card;
import it.cnr.iit.jscontact.tools.vcard.converters.ezvcard2jscontact.EZVCard2JSContact;
import it.cnr.iit.jscontact.tools.vcard.converters.config.VCard2JSContactConfig;
import it.cnr.iit.jscontact.tools.exceptions.CardException;
import it.cnr.iit.jscontact.tools.vcard.extensions.utils.VCardParser;
import lombok.Builder;

import java.util.List;

/**
 * Utility class for converting an xCard [RFC6351] into a JSContact object.
 *
 * @see RFC6351
 * @author Mario Loffredo
 */
public class XCard2JSContact extends EZVCard2JSContact {

    @Builder
    public XCard2JSContact(VCard2JSContactConfig config) {
        super();
        this.config = config;
    }

    /**
     * Converts a complete vCard v4.0 [RFC6350] in XML format, namely xCard [RFC6351], into a list of Card objects.
     * JSContact is defined in [RFC9553].
     * JSContact extensions to vCard are defined in [RFC9554]
     * Conversion rules are defined in [RFC9555].
     *
     * @param xCard an xCard as an XML string
     * @return the list of Card objects
     * @throws CardException if the xCard is not v4.0 compliant
     * @see RFC6350
     * @see RFC6351
     * @see RFC9553
     * @see RFC9554
     * @see RFC9555
     */
    public List convert(String xCard) throws CardException {

        List vcards = VCardParser.parseXml(xCard);
        if (vcards.size() == 0)
            throw new CardException("Bad xCard format");
        return convert(vcards.toArray(new VCard[0]));
    }

}