1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski package com.sun.star.uno; 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski import java.io.IOException; 27*b1cdbd2cSJim Jagielski 28*b1cdbd2cSJim Jagielski /** 29*b1cdbd2cSJim Jagielski * This is abstract interface for bridges. 30*b1cdbd2cSJim Jagielski * 31*b1cdbd2cSJim Jagielski * <p>Bridges are able to map one object from one UNO environment to another and 32*b1cdbd2cSJim Jagielski * vice versa.<p> 33*b1cdbd2cSJim Jagielski * 34*b1cdbd2cSJim Jagielski * @see com.sun.star.uno.IBridge 35*b1cdbd2cSJim Jagielski * @see com.sun.star.uno.IQueryInterface 36*b1cdbd2cSJim Jagielski * @see com.sun.star.uno.UnoRuntime 37*b1cdbd2cSJim Jagielski * 38*b1cdbd2cSJim Jagielski * @deprecated As of UDK 3.2, this interface is deprecated, without offering a 39*b1cdbd2cSJim Jagielski * replacement. 40*b1cdbd2cSJim Jagielski */ 41*b1cdbd2cSJim Jagielski public interface IBridge { 42*b1cdbd2cSJim Jagielski /** 43*b1cdbd2cSJim Jagielski * Maps an object from the source environment to the destination 44*b1cdbd2cSJim Jagielski * environment. 45*b1cdbd2cSJim Jagielski * 46*b1cdbd2cSJim Jagielski * @param object the object to map 47*b1cdbd2cSJim Jagielski * @param type the type of the interface that shall be mapped 48*b1cdbd2cSJim Jagielski * @return the object in the destination environment 49*b1cdbd2cSJim Jagielski */ mapInterfaceTo(Object object, Type type)50*b1cdbd2cSJim Jagielski Object mapInterfaceTo(Object object, Type type); 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski /** 53*b1cdbd2cSJim Jagielski * Maps an object from the destination environment to the source 54*b1cdbd2cSJim Jagielski * environment. 55*b1cdbd2cSJim Jagielski * 56*b1cdbd2cSJim Jagielski * @param object the object to map 57*b1cdbd2cSJim Jagielski * @param type the type of the interface that shall be mapped 58*b1cdbd2cSJim Jagielski * @return the object in the source environment 59*b1cdbd2cSJim Jagielski */ mapInterfaceFrom(Object object, Type type)60*b1cdbd2cSJim Jagielski Object mapInterfaceFrom(Object object, Type type); 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski /** 63*b1cdbd2cSJim Jagielski * Returns the source environment. 64*b1cdbd2cSJim Jagielski * 65*b1cdbd2cSJim Jagielski * @return the source environment of this bridge 66*b1cdbd2cSJim Jagielski */ getSourceEnvironment()67*b1cdbd2cSJim Jagielski IEnvironment getSourceEnvironment(); 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski /** 70*b1cdbd2cSJim Jagielski * Returns the destination environment. 71*b1cdbd2cSJim Jagielski * 72*b1cdbd2cSJim Jagielski * @return the destination environment of this bridge 73*b1cdbd2cSJim Jagielski */ getTargetEnvironment()74*b1cdbd2cSJim Jagielski IEnvironment getTargetEnvironment(); 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski /** 77*b1cdbd2cSJim Jagielski * Increases the life count. 78*b1cdbd2cSJim Jagielski */ acquire()79*b1cdbd2cSJim Jagielski void acquire(); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski /** 82*b1cdbd2cSJim Jagielski * Decreases the life count. 83*b1cdbd2cSJim Jagielski * 84*b1cdbd2cSJim Jagielski * <p>If the life count drops to zero, the bridge disposes itself.</p> 85*b1cdbd2cSJim Jagielski */ release()86*b1cdbd2cSJim Jagielski void release(); 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski /** 89*b1cdbd2cSJim Jagielski * Disposes the bridge. 90*b1cdbd2cSJim Jagielski * 91*b1cdbd2cSJim Jagielski * <p>Sends involved threads an <code>InterruptedException</code>. Releases 92*b1cdbd2cSJim Jagielski * mapped objects.</p> 93*b1cdbd2cSJim Jagielski */ dispose()94*b1cdbd2cSJim Jagielski void dispose() throws InterruptedException, IOException; 95*b1cdbd2cSJim Jagielski } 96