org.jnosql.artemis.graph.GraphEntityPrePersist 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.graph;

import static java.util.Objects.requireNonNull;

/**
 * The interface represents the model before the {@link ArtemisVertex} be saved that  event will fired.
 */
public interface GraphEntityPrePersist {


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

    /**
     * Creates the {@link GraphEntityPrePersist} instance
     *
     * @param entity the entity
     * @return {@link GraphEntityPrePersist} instance
     * @throws NullPointerException when the entity is null
     */
    static GraphEntityPrePersist of(ArtemisVertex entity) throws NullPointerException {
        requireNonNull(entity, "Entity is required");
        return new DefaultGraphEntityPrePersist(entity);
    }
}