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

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