org.hibernate.service.spi.Wrapped Maven / Gradle / Ivy
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2011, Red Hat Inc. or third-party contributors as
* indicated by the @author tags or express copyright attribution
* statements applied by the authors. All third-party contributions are
* distributed under license by Red Hat Inc.
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301 USA
*/
package org.hibernate.service.spi;
/**
* Optional contract for services that wrap stuff that to which it is useful to have access. For example, a service
* that maintains a {@link javax.sql.DataSource} might want to expose access to the {@link javax.sql.DataSource} or
* its {@link java.sql.Connection} instances.
*
* @author Steve Ebersole
*/
public interface Wrapped {
/**
* Can this wrapped service be unwrapped as the indicated type?
*
* @param unwrapType The type to check.
*
* @return True/false.
*/
public boolean isUnwrappableAs(Class unwrapType);
/**
* Unproxy the service proxy
*
* @param unwrapType The java type as which to unwrap this instance.
*
* @return The unwrapped reference
*
* @throws UnknownUnwrapTypeException if the servicebe unwrapped as the indicated type
*/
public T unwrap(Class unwrapType);
}