org.intellimate.izou.sdk.util.ResourceCreator Maven / Gradle / Ivy

Go to download
package org.intellimate.izou.sdk.util;

import org.intellimate.izou.identification.Identifiable;
import org.intellimate.izou.identification.Identification;
import org.intellimate.izou.identification.IdentificationManager;
import org.intellimate.izou.sdk.resource.Resource;

import java.util.ArrayList;
import java.util.List;
import java.util.Optional;

/**
 * provides various utility-methods to create Resources.
 * @author Leander Kurscheidt
 * @version 1.0
 * @see Resource
 */
public interface ResourceCreator extends ContextProvider, Identifiable {
    /**
     * creates a new Resource with the specified ID (=Name)
     * @param id the id
     * @param  the data-type of the resource
     * @return an Optional which can contain a Resource
     */
    default  Optional> createResource(String id) {
        return createResource(id, null, null);
    }

    /**
     * creates a new Resource with the specified ID (=Name)
     * @param id the id
     * @param consumer the consumer of the Resource
     * @param  the data-type of the resource
     * @return an Optional which can contain a Resource
     */
    default  Optional> createResource(String id, Identification consumer) {
        return createResource(id, null, consumer);
    }

    /**
     * creates a new Resource with the specified ID (=Name)
     * @param id the id
     * @param t the data
     * @param  the data-type of the resource
     * @return an Optional which can contain a Resource
     */
    default  Optional> createResource(String id, T t) {
        return createResource(id, t, null);
    }

    /**
     * creates a new Resource with the specified ID (=Name)
     * @param id the id
     * @param t the data
     * @param consumer the consumer of the Resource
     * @param  the data-type of the resource
     * @return an Optional which can contain a Resource
     */
    default  Optional> createResource(String id, T t, Identification consumer) {
        if (id == null || id.isEmpty()) {
            getContext().getLogger().error("resource id is null or empty");
            return Optional.empty();
        }
        Optional> generated = IdentificationManager.getInstance().getIdentification(this)
                .map(idProvider -> new Resource<>(id, idProvider, t, consumer));
        if (!generated.isPresent())
            getContext().getLogger().error("unable to generate Resource");
        return generated;
    }

    /**
     * utility method to create a list from an Optional.
     * @param optional the Optional to create the List from
     * @param  the type
     * @return a List containing something is the optional is not empty
     */
    default  List optionalToList(Optional optional) {
        return optional
                .map(t -> {
                    List list = new ArrayList<>();
                    list.add(t);
                    return list;
                })
                .orElse(new ArrayList<>());
    }
}