概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| UDK 3.1.0 Java API Reference
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## com.sun.star.uno
インタフェース IEnvironment

public interface IEnvironment

The interface implemented by UNO environments.

With this interface, objects can be registered at and revoked from an environment.

導入されたバージョン:
  UDK1.0
関連項目:
  `UnoRuntime`, `IQueryInterface`, `IBridge`

メソッドの概要
`Object` | `getContext()` Gets the context of this environment.
`String` | `getName()` Gets the name of this environment.
`Object` | `getRegisteredInterface(String oid, Type type)` Retrieves a registered object, specified by OID and UNO interface type.
`String` | `getRegisteredObjectIdentifier(Object object)` Retrieves the OID for a registered object.
`void` | `list()` Lists the registered objects to `System.out`.
`Object` | `registerInterface(Object object, String[] oid, Type type)` Registers one UNO interface facet of an object.
`void` | `revokeInterface(String oid, Type type)` Explicitly revokes a UNO interface facet.

メソッドの詳細

### getContext

    public Object getContext()

  Gets the context of this environment.

  戻り値:
    the context of this environment

### getName

    public String getName()

  Gets the name of this environment.

  戻り値:
    the name of this environment

### registerInterface

    public Object registerInterface(Object object,
                                    String[] oid,
                                    Type type)

  Registers one UNO interface facet of an object.

  Such an object will typically be one of three things:

  - A local Java object, to be mapped out of this environment via a given bridge.
  - A proxy object, mapped into this environment via some bridge B1, and now to be mapped out of this environment via a given bridge B2.
  - A proxy object, created as a remote object is mapped into this environment via a given bridge.

  The object actually registered may differ from the specified `object` that is passed as an argument. This enables an environment to work in a multi-threaded scenario, where two threads can call `registerInterface` for the same combination of `oid` and `type` at the same time; the race condition is solved by letting one of the calls register its argument `object`, ignoring the argument `object` of the other call, and letting both calls return the same `object`.

  The registered object is held only weakly by the environment. After a call to `registerInterface`, a call to `getRegisteredInterface` only succeeds as long as the registered object is still strongly reachable, and the registered object has not been explicitly revoked by calling `revokeInterface`.

  パラメータ:
    `object` - the object to register; must be non-null
    `oid` - in-out parameter containing the OID of `object`. 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).
    `type` - the UNO interface type to register. This argument must be non-null, and must denote a UNO interface type. The given `object` should implement this `type`.
  戻り値:
    the registered object (may differ from the `object` passed in); will never be null

### revokeInterface

    public void revokeInterface(String oid,
                                Type type)

  Explicitly revokes a UNO interface facet.

  Calls to `registerInterface` and `revokeInterface` 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 `revokeInterface` (and calls to `revokeInterface` would no longer be necessary if the calling code does not want to control the temporal extent of the registration).

  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.

  パラメータ:
    `oid` - the OID of the object to revoke; must be non-null
    `type` - the UNO interface type of the object to revoke. This argument must be non-null, and must denote a UNO interface type.

### getRegisteredInterface

    public Object getRegisteredInterface(String oid,
                                         Type type)

  Retrieves a registered object, specified by OID and UNO interface type.

  パラメータ:
    `oid` - the OID of the object to retrieve; must be non-null
    `type` - the UNO interface type of the object to retrieve. This argument must be non-null, and must denote a UNO interface type.
  戻り値:
    the registered object, or null if none is found

### getRegisteredObjectIdentifier

    public String getRegisteredObjectIdentifier(Object object)

  Retrieves the OID for a registered object.

  パラメータ:
    `object` - a registered object; must be non-null
  戻り値:
    the OID of the `object`; will never be null

### list

    public void list()

  Lists the registered objects to `System.out`.

  This is for debug purposes.

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| UDK 3.1.0 Java API Reference
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド