io.citrine.jpif.obj.common.License Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jpif Show documentation
This package includes java objects for all items in the Physical Information File (PIF), http://www.citrine.io/pif. Files formatted in the PIF schema can be serialized and deserialized using included methods.
There is a newer version: 2.7.2
Show newest version
package io.citrine.jpif.obj.common;

import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonToken;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import io.citrine.jpif.util.PifObjectMapper;
import io.citrine.jpif.util.PifSerializationUtil;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.ObjectStreamException;
import java.io.Serializable;
import java.net.MalformedURLException;
import java.net.URL;

/**
 * Information about a license that applies to some item.
 *
 * Supported fields:
 * 

 *     name - Name of the license.
 *     
description - Description of the license.
 *     
url - URL to the license.
 *     
tags - List of tags that apply to the license.
 * 
 *
 * @author Kyle Michel
 */
public class License extends Pio implements Serializable {

    /**
     * Set the name of the license.
     *
     * @param name String with the name of the license.
     * @return This object.
     */
    @JsonSetter(value = "name")
    public License setName(final String name) {
        this.name = name;
        return this;
    }

    /**
     * Get the name of the license.
     *
     * @return String with the name of the license.
     */
    @JsonGetter(value = "name")
    public String getName() {
        return this.name;
    }

    /**
     * Set the description of the license.
     *
     * @param description String with the description of the license.
     * @return This object.
     */
    @JsonSetter(value = "description")
    public License setDescription(final String description) {
        this.description = description;
        return this;
    }

    /**
     * Get the description of the license.
     *
     * @return String with the description of the license.
     */
    @JsonGetter(value = "description")
    public String getDescription() {
        return this.description;
    }

    /**
     * Set the URL to the license.
     *
     * @param url String with the URL to the license.
     * @return This object.
     */
    @JsonSetter(value = "url")
    public License setUrl(final String url) {
        this.url = url;
        return this;
    }

    /**
     * Get the URL to the license.
     *
     * @return String with the URL to the license.
     */
    @JsonGetter(value = "url")
    public String getUrl() {
        return this.url;
    }

    @Override
    public License addTag(final String tag) {
        super.addTag(tag);
        return this;
    }

    @Override
    public License addTag(final int index, final String tag) {
        super.addTag(index, tag);
        return this;
    }

    @Override
    @JsonAnySetter
    public License addUnsupportedField(final String key, final Object value) {
        super.addUnsupportedField(key, value);
        return this;
    }

    /**
     * Create a new {@link License} object from the input string. This function first checks whether the string is
     * formatted as a URL and saves it as such if so. It then assumes that the string is the name of the license
     * unless it contains more than 50 characters, in which case it assumes a description.
     *
     * @param input String to convert to {@link License} object.
     * @return {@link License} object with the value of the string.
     */
    public static License valueOf(final String input) {
        return (input == null)
                ? null
                : interpretLicenseString(input);
    }

    /**
     * Interpret an input license string as a url, name, or description.
     *
     * @param input String to convert to {@link License} object.
     * @return {@link License} object with the value of the string.
     */
    protected static License interpretLicenseString(final String input) {
        final License res = new License();
        if (isValidUrl(input)) {
            res.setUrl(input);
        }
        else if (input.length() < 50) {
            res.setName(input);
        }
        else {
            res.setDescription(input);
        }
        return res;
    }

    /**
     * Helper function that determines whether an input string is a valid URL.
     *
     * @param input String to check as a URL.
     * @return True if the input string is a URL.
     */
    protected static boolean isValidUrl(final String input) {
        // This purposely uses try catch logic to determine whether the input string is a valid url
        try {
            new URL(input);
            return true;
        }
        catch (MalformedURLException e) {
            return false;
        }
    }

    /**
     * Write this object to the output output stream.
     *
     * @param out {@link ObjectOutputStream} to write to.
     * @throws IOException if this object cannot be written.
     */
    private void writeObject(ObjectOutputStream out) throws IOException {
        PifSerializationUtil.write(out, this);
    }

    /**
     * Read into this object from the input stream.
     *
     * @param in {@link ObjectInputStream} to read from.
     * @throws IOException if thrown while reading the stream.
     * @throws ClassNotFoundException if thrown while reading the stream.
     */
    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        PifSerializationUtil.read(in, this);
    }

    /**
     * Read an object with no data.
     *
     * @throws ObjectStreamException if thrown while reading the stream.
     */
    private void readObjectNoData() throws ObjectStreamException {}

    private static final long serialVersionUID = -409398361626668427L;

    /** Name of the license. */
    private String name;

    /** Description of the license. */
    private String description;

    /** URL to the license. */
    private String url;

    /**
     * Class used to deserialize a JSON value into a {@link License} object. If the input value is a string, this
     * function tries to determine whether it should be marked as a name, description, or URL. If the input value
     * is an object, then it is converted directly to a {@link License} object.
     *
     * @author Kyle Michel
     */
    public static class Deserializer extends JsonDeserializer {

        @Override
        public License deserialize(JsonParser jsonParser, DeserializationContext deserializationContext)
                throws IOException {
            final JsonToken jsonToken = jsonParser.getCurrentToken();
            switch (jsonToken) {
                case VALUE_STRING:
                    return License.valueOf(jsonParser.getValueAsString());
                case START_OBJECT:
                    return PifObjectMapper.getInstance().readValue(jsonParser, License.class);
                default:
                    throw deserializationContext.mappingException(License.class, jsonToken);
            }
        }
    }
}