it.cnr.iit.jscontact.tools.dto.DirectoryKind 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.dto;

import com.fasterxml.jackson.annotation.JsonIgnore;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;
import lombok.experimental.SuperBuilder;

import java.io.Serializable;

/**
 * Class mapping the values of the "kind" property of the DirectoryResource type as defined in section 2.6.2 of [RFC9553].
 *
 * @see Section 2.6.2 of RFC9553
 * @author Mario Loffredo
 */
@Getter
@Setter
@ToString(callSuper = true)
@NoArgsConstructor
@SuperBuilder
public class DirectoryKind extends ExtensibleEnumType implements Serializable {

    /**
     * Tests if this directory resource type is "directory".
     *
     * @return true if directory resource type is "directory", false otherwise
     */
    @JsonIgnore
    public boolean isDirectory() { return isRfc(DirectoryEnum.DIRECTORY); }

    /**
     * Tests if this directory resource type is "entry".
     *
     * @return true if directory resource type is "entry", false otherwise
     */
    @JsonIgnore
    public boolean isEntry() { return isRfc(DirectoryEnum.ENTRY); }


    private static DirectoryKind rfc(DirectoryEnum rfcValue) { return DirectoryKind.builder().rfcValue(rfcValue).build(); }

    /**
     * Returns a "directory" directory resource type.
     *
     * @return a "directory" directory resource type
     */
    public static DirectoryKind directory() { return rfc(DirectoryEnum.DIRECTORY);}

    /**
     * Returns an "entry" directory resource type.
     *
     * @return an "entry" directory resource type
     */
    public static DirectoryKind entry() { return rfc(DirectoryEnum.ENTRY);}

    /**
     * Returns a custom directory resource type.
     *
     * @param extValue a custom directory source type in text format
     * @return a custom directory resource type
     */
    public static DirectoryKind ext(String extValue) { return DirectoryKind.builder().extValue(V_Extension.toV_Extension(extValue)).build(); }
}