edu.stanford.protege.webprotege.crud.persistence.ProjectEntityCrudKitSettings Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of webprotege-backend-api Show documentation

The newest version!

package edu.stanford.protege.webprotege.crud.persistence;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.auto.value.AutoValue;
import edu.stanford.protege.webprotege.common.ProjectId;
import edu.stanford.protege.webprotege.crud.EntityCrudKitSettings;

import javax.annotation.Nonnull;

/**
 * Author: Matthew Horridge

 * Stanford University

 * Bio-Medical Informatics Research Group

 * Date: 21/08/2013
 * 
 *     Captures the {@link EntityCrudKitSettings} for a project.
 * 
 */
@AutoValue

public abstract class ProjectEntityCrudKitSettings {


    public static final String PROJECT_ID = "_id";

    public static final String SETTINGS = "settings";

    /**
     * Constructs a {@link ProjectEntityCrudKitSettings}, which specifies the {@link EntityCrudKitSettings} for a
     * specified project.
     *
     * @param projectId The {@link ProjectId} that identifies the settings that apply to the project.  Not {@code null}.
     * @param settings  The settings that apply to the project.  Not {@code null}.
     * @throws NullPointerException if any parameters are {@code null}.
     */
    @JsonCreator
    public static ProjectEntityCrudKitSettings get(@JsonProperty(PROJECT_ID) @Nonnull ProjectId projectId,
                                                   @JsonProperty(
                                                           SETTINGS) @Nonnull EntityCrudKitSettings settings) {

        return new AutoValue_ProjectEntityCrudKitSettings(projectId, settings);
    }

    /**
     * Gets the {@link ProjectId}, which specifies the project that these settings apply to.
     *
     * @return The {@link ProjectId}.  Not {@code null}.
     */
    @JsonProperty(PROJECT_ID)
    public abstract ProjectId getProjectId();

    /**
     * Gets the {@link EntityCrudKitSettings} for the project.
     *
     * @return The settings.  Not {@code null}.
     */
    @JsonProperty(SETTINGS)
    public abstract EntityCrudKitSettings getSettings();
}