<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.7.0-internal) on Thu Oct 16 10:00:06 EDT 2008 -->
<TITLE>
IEnvironment (Java UNO Runtime Reference)
</TITLE>
<META NAME="date" CONTENT="2008-10-16">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="IEnvironment (Java UNO Runtime Reference)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IEnvironment.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
UDK 3.2.7 Java API Reference</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/sun/star/uno/IBridge.html" title="interface in com.sun.star.uno"><B>PREV CLASS</B></A>
<A HREF="../../../../com/sun/star/uno/IFieldDescription.html" title="interface in com.sun.star.uno"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/sun/star/uno/IEnvironment.html" target="_top"><B>FRAMES</B></A>
<A HREF="IEnvironment.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sun.star.uno</FONT>
<BR>
Interface IEnvironment</H2>
<HR>
<B>Deprecated.</B> <I>As of UDK 3.2, this interface is deprecated, without offering a
replacement.</I>
<P>
<DL>
<DT><PRE>public interface <B>IEnvironment</B></DL>
</PRE>
<P>
The interface implemented by UNO environments.
<p>With this interface, objects can be registered at and revoked from an
environment.</p>
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/star/uno/IBridge.html" title="interface in com.sun.star.uno"><CODE>IBridge</CODE></A>,
<A HREF="../../../../com/sun/star/uno/IQueryInterface.html" title="interface in com.sun.star.uno"><CODE>IQueryInterface</CODE></A>,
<A HREF="../../../../com/sun/star/uno/UnoRuntime.html" title="class in com.sun.star.uno"><CODE>UnoRuntime</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/star/uno/IEnvironment.html#getContext()">getContext</A></B>()</CODE>
<BR>
<B>Deprecated.</B> Gets the context of this environment.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/star/uno/IEnvironment.html#getName()">getName</A></B>()</CODE>
<BR>
<B>Deprecated.</B> Gets the name of this environment.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/star/uno/IEnvironment.html#getRegisteredInterface(java.lang.String, com.sun.star.uno.Type)">getRegisteredInterface</A></B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> oid,
<A HREF="../../../../com/sun/star/uno/Type.html" title="class in com.sun.star.uno">Type</A> type)</CODE>
<BR>
<B>Deprecated.</B> Retrieves a registered object, specified by OID and UNO interface type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/star/uno/IEnvironment.html#getRegisteredObjectIdentifier(java.lang.Object)">getRegisteredObjectIdentifier</A></B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> object)</CODE>
<BR>
<B>Deprecated.</B> Retrieves the OID for a registered object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/star/uno/IEnvironment.html#list()">list</A></B>()</CODE>
<BR>
<B>Deprecated.</B> Lists the registered objects to <code>System.out</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/star/uno/IEnvironment.html#registerInterface(java.lang.Object, java.lang.String[], com.sun.star.uno.Type)">registerInterface</A></B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> object,
<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] oid,
<A HREF="../../../../com/sun/star/uno/Type.html" title="class in com.sun.star.uno">Type</A> type)</CODE>
<BR>
<B>Deprecated.</B> Registers one UNO interface facet of an object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/star/uno/IEnvironment.html#revokeInterface(java.lang.String, com.sun.star.uno.Type)">revokeInterface</A></B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> oid,
<A HREF="../../../../com/sun/star/uno/Type.html" title="class in com.sun.star.uno">Type</A> type)</CODE>
<BR>
<B>Deprecated.</B> Explicitly revokes a UNO interface facet.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getContext()"><!-- --></A><H3>
getContext</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getContext</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>Gets the context of this environment.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the context of this environment</DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>Gets the name of this environment.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the name of this environment</DL>
</DD>
</DL>
<HR>
<A NAME="registerInterface(java.lang.Object, java.lang.String[], com.sun.star.uno.Type)"><!-- --></A><H3>
registerInterface</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>registerInterface</B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> object,
<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] oid,
<A HREF="../../../../com/sun/star/uno/Type.html" title="class in com.sun.star.uno">Type</A> type)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>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>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>object</CODE> - the object to register; must be non-null<DD><CODE>oid</CODE> - 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).<DD><CODE>type</CODE> - 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>.
<DT><B>Returns:</B><DD>the registered object (may differ from the <code>object</code>
passed in); will never be null</DL>
</DD>
</DL>
<HR>
<A NAME="revokeInterface(java.lang.String, com.sun.star.uno.Type)"><!-- --></A><H3>
revokeInterface</H3>
<PRE>
void <B>revokeInterface</B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> oid,
<A HREF="../../../../com/sun/star/uno/Type.html" title="class in com.sun.star.uno">Type</A> type)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>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>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>oid</CODE> - the OID of the object to revoke; must be non-null<DD><CODE>type</CODE> - the UNO interface type of the object to revoke. This
argument must be non-null, and must denote a UNO interface type.</DL>
</DD>
</DL>
<HR>
<A NAME="getRegisteredInterface(java.lang.String, com.sun.star.uno.Type)"><!-- --></A><H3>
getRegisteredInterface</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>getRegisteredInterface</B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> oid,
<A HREF="../../../../com/sun/star/uno/Type.html" title="class in com.sun.star.uno">Type</A> type)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>Retrieves a registered object, specified by OID and UNO interface type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>oid</CODE> - the OID of the object to retrieve; must be non-null<DD><CODE>type</CODE> - the UNO interface type of the object to retrieve. This
argument must be non-null, and must denote a UNO interface type.
<DT><B>Returns:</B><DD>the registered object, or null if none is found</DL>
</DD>
</DL>
<HR>
<A NAME="getRegisteredObjectIdentifier(java.lang.Object)"><!-- --></A><H3>
getRegisteredObjectIdentifier</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getRegisteredObjectIdentifier</B>(<A HREF="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> object)</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>Retrieves the OID for a registered object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>object</CODE> - a registered object; must be non-null
<DT><B>Returns:</B><DD>the OID of the <code>object</code>; will never be null</DL>
</DD>
</DL>
<HR>
<A NAME="list()"><!-- --></A><H3>
list</H3>
<PRE>
void <B>list</B>()</PRE>
<DL>
<DD><B>Deprecated.</B> <DD>Lists the registered objects to <code>System.out</code>.
<p>This is for debug purposes.</p>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IEnvironment.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
UDK 3.2.7 Java API Reference</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../com/sun/star/uno/IBridge.html" title="interface in com.sun.star.uno"><B>PREV CLASS</B></A>
<A HREF="../../../../com/sun/star/uno/IFieldDescription.html" title="interface in com.sun.star.uno"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?com/sun/star/uno/IEnvironment.html" target="_top"><B>FRAMES</B></A>
<A HREF="IEnvironment.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
9767
