ridljar/com/sun/star/uno/IBridge.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: IBridge.java,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 package com.sun.star.uno;
  32
  33 import java.io.IOException;
  34
  35 /**
  36  * This is abstract interface for bridges.
  37  *
  38  * <p>Bridges are able to map one object from one UNO environment to another and
  39  * vice versa.<p>
  40  *
  41  * @see com.sun.star.uno.IBridge
  42  * @see com.sun.star.uno.IQueryInterface
  43  * @see com.sun.star.uno.UnoRuntime
  44  *
  45  * @deprecated As of UDK 3.2, this interface is deprecated, without offering a
  46  * replacement.
  47  */
  48 public interface IBridge {
  49     /**
  50      * Maps an object from the source environment to the destination
  51      * environment.
  52      *
  53      * @param object the object to map
  54      * @param type the type of the interface that shall be mapped
  55      * @return the object in the destination environment
  56      */
  57     Object mapInterfaceTo(Object object, Type type);
  58
  59     /**
  60      * Maps an object from the destination environment to the source
  61      * environment.
  62      *
  63      * @param object the object to map
  64      * @param type the type of the interface that shall be mapped
  65      * @return the object in the source environment
  66      */
  67     Object mapInterfaceFrom(Object object, Type type);
  68
  69     /**
  70      * Returns the source environment.
  71      *
  72      * @return the source environment of this bridge
  73      */
  74     IEnvironment getSourceEnvironment();
  75
  76     /**
  77      * Returns the destination environment.
  78      *
  79      * @return the destination environment of this bridge
  80      */
  81     IEnvironment getTargetEnvironment();
  82
  83     /**
  84      * Increases the life count.
  85      */
  86     void acquire();
  87
  88     /**
  89      * Decreases the life count.
  90      *
  91      * <p>If the life count drops to zero, the bridge disposes itself.</p>
  92      */
  93     void release();
  94
  95     /**
  96      * Disposes the bridge.
  97      *
  98      * <p>Sends involved threads an <code>InterruptedException</code>.  Releases
  99      * mapped objects.</p>
 100      */
 101     void dispose() throws InterruptedException, IOException;
 102 }