org.jnosql.artemis.document.DocumentEntityPrePersist Maven / Gradle / Ivy

Go to download
/*
 *  Copyright (c) 2017 Otávio Santana and others
 *   All rights reserved. This program and the accompanying materials
 *   are made available under the terms of the Eclipse Public License v1.0
 *   and Apache License v2.0 which accompanies this distribution.
 *   The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 *   and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
 *
 *   You may elect to redistribute this code under either of these licenses.
 *
 *   Contributors:
 *
 *   Otavio Santana
 */
package org.jnosql.artemis.document;


import org.jnosql.diana.api.document.DocumentEntity;

import java.util.Objects;

/**
 * The interface represents the model before the DocumentCollectionEntity be saved that  event will fired.
 */
public interface DocumentEntityPrePersist {

    /**
     * The {@link DocumentEntity}  before be saved
     *
     * @return the {@link DocumentEntity} instance
     */
    DocumentEntity getEntity();

    /**
     * Creates the {@link DocumentEntityPrePersist} instance
     *
     * @param entity the entity
     * @return {@link DocumentEntityPrePersist} instance
     * @throws NullPointerException when the entity is null
     */
    static DocumentEntityPrePersist of(DocumentEntity entity) {
        Objects.requireNonNull(entity, "Entity is required");
        return new DefaultDocumentEntityPrePersist(entity);
    }
}