com.github.jmnarloch.hstreams.StreamStatelessSession Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hstreams5 Show documentation
Hibernate JDK 8 wrapper
The newest version!
/**
 * Copyright (c) 2015 HStreams contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.github.jmnarloch.hstreams;

import org.hibernate.LockMode;
import org.hibernate.StatelessSession;

import java.io.Serializable;
import java.util.Optional;

/**
 * A wrapper around the {@link StatelessSession} interface that overrides most of the methods return types.
 *
 * @author Jakub Narloch
 */
public interface StreamStatelessSession extends BaseStreamSession, StatelessSession {

    /**
     * Returns the persistent instance of the given entity class that matches the given identifier,
     * the value is  wrapped into {@link Optional}. (If the instance is already associated with
     * the session, return that instance. This method never returns an uninitialized instance.)
     * Obtains the specified lock mode if the instance exists.
     *
     * @param clazz    a persistent type
     * @param id       an identifier
     * @param lockMode the lock mode
     * @param       the entity type
     * @return an optional persistence instance
     */
     Optional getOptional(Class clazz, Serializable id, LockMode lockMode);

    /**
     * Return the persistent instance of the given named entity that matches the given identifier,
     * the value is  wrapped into {@link Optional}. (If the instance is already associated with
     * the session, return that instance. This method never returns an uninitialized instance.)
     * Obtains the specified lock mode if the instance exists.
     *
     * @param entityName the entity name
     * @param id         an identifier
     * @param lockMode   the lock mode
     * @param         the entity type
     * @return an optional persistence instance
     */
     Optional getOptional(String entityName, Serializable id, LockMode lockMode);
}