1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: IEnvironment.java,v $
* $Revision: 1.5 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
package com.sun.star.uno;
/**
* The interface implemented by UNO environments.
*
* <p>With this interface, objects can be registered at and revoked from an
* environment.</p>
*
* @see com.sun.star.uno.IBridge
* @see com.sun.star.uno.IQueryInterface
* @see com.sun.star.uno.UnoRuntime
*
* @deprecated As of UDK 3.2, this interface is deprecated, without offering a
* replacement.
*/
public interface IEnvironment {
/**
* Gets the context of this environment.
*
* @return the context of this environment
*/
Object getContext();
/**
* Gets the name of this environment.
*
* @return the name of this environment
*/
String getName();
/**
* Registers one UNO interface facet of an object.
*
* <p>Such an object will typically be one of three things:
* <ul>
* <li>A local Java object, to be mapped out of this environment via a given
* bridge.</li>
* <li>A proxy object, mapped into this environment via some bridge
* <var>B1</var>, and now to be mapped out of this environment via a
* given bridge <var>B2</var>.</li>
* <li>A proxy object, created as a remote object is mapped into this
* environment via a given bridge.</li>
* </ul></p>
*
* <p>The object actually registered may differ from the specified
* <code>object</code> that is passed as an argument. This enables an
* environment to work in a multi-threaded scenario, where two threads can
* call <code>registerInterface</code> for the same combination of
* <code>oid</code> and <code>type</code> at the same time; the race
* condition is solved by letting one of the calls register its argument
* <code>object</code>, ignoring the argument <code>object</code> of the
* other call, and letting both calls return the same
* <code>object</code>.</p>
*
* <p>The registered object is held only weakly by the environment. After a
* call to <code>registerInterface</code>, a call to
* <code>getRegisteredInterface</code> only succeeds as long as the
* registered object is still strongly reachable, and the registered object
* has not been explicitly revoked by calling
* <code>revokeInterface</code>.</p>
*
* @param object the object to register; must be non-null
* @param oid in-out parameter containing the OID of <code>object</code>.
* This must be a non-null reference to an array of length at least one;
* the zeroth element is used to pass the argument in and out. If the
* zeroth element is null on input, the OID will be computed and passed
* out (that is, the zeroth element will never be null upon normal
* return).
* @param type the UNO interface type to register. This argument must be
* non-null, and must denote a UNO interface type. The given
* <code>object</code> should implement this <code>type</code>.
* @return the registered object (may differ from the <code>object</code>
* passed in); will never be null
*/
Object registerInterface(Object object, String[] oid, Type type);
/**
* Explicitly revokes a UNO interface facet.
*
* <p>Calls to <code>registerInterface</code> and
* <code>revokeInterface</code> must be paired. A facet is only removed
* from the environment when it has been revoked as often as it has been
* registered. This may change in the future, so that a facet would be
* removed upon the first call to <code>revokeInterface</code> (and calls to
* <code>revokeInterface</code> would no longer be necessary if the calling
* code does not want to control the temporal extent of the
* registration).</p>
*
* <p>It is not an error if the specified facet is not registered at this
* environment (either because no corresponding object has ever been
* registered, or it has been explicitly revoked, or it is no longer
* strongly reachable). In such a case, this method simply does
* nothing.</p>
*
* @param oid the OID of the object to revoke; must be non-null
* @param type the UNO interface type of the object to revoke. This
* argument must be non-null, and must denote a UNO interface type.
*/
void revokeInterface(String oid, Type type);
/**
* Retrieves a registered object, specified by OID and UNO interface type.
*
* @param oid the OID of the object to retrieve; must be non-null
* @param type the UNO interface type of the object to retrieve. This
* argument must be non-null, and must denote a UNO interface type.
* @return the registered object, or null if none is found
*/
Object getRegisteredInterface(String oid, Type type);
/**
* Retrieves the OID for a registered object.
*
* @param object a registered object; must be non-null
* @return the OID of the <code>object</code>; will never be null
*/
String getRegisteredObjectIdentifier(Object object);
/**
* Lists the registered objects to <code>System.out</code>.
*
* <p>This is for debug purposes.</p>
*/
void list();
}
|
