Interface XStorage

Devguide

索引

Methods' 要約

せいにするs' 要約

Methods' 詳細（に述べる）s

せいにするs' 詳細（に述べる）s

:: com :: sun :: 星／主役にする :: embed ::

interface XStorage

Base Interfaces

XStorage
┣ ::com::sun::星／主役にする::コンテナ::XNameAccess
┃ ┗ ::com::sun::星／主役にする::コンテナ::XElementAccess
┗ ::com::sun::星／主役にする::lang::XComponent

::com::sun::星／主役にする::コンテナ::XNameAccess	Description 許すs to get 名簿（に載せる）／表（にあげる） of child elements and to check if an element with a 明示するd 指名する存在するs in a 貯蔵. It is also possible to use this interface to get read 接近 to a child element by XNameAccess::getByName call. But the recommended way is to use XStorage interface for this 目的.
::com::sun::星／主役にする::lang::XComponent	Description 許すs to controll and 跡をつける lifetime of the 貯蔵. In 事例／患者 a 貯蔵 is 性質の／したい気がして any call to it's methods should result in ::com::sun::星／主役にする::lang::DisposedException.

Description: This interface 代表するs main 貯蔵 functionality.

Methods' 要約
copyToStorage	許すs to copy 現在の貯蔵 to another one
openStreamElement	許すs to get 接近 to a child stream of the 貯蔵.
openEncryptedStreamElement	許すs to get 接近 to a child encrypted stream with password.
openStorageElement	許すs to get 接近 to a child 貯蔵.
cloneStreamElement	許すs to get readonly copy of a child stream of the 貯蔵.
cloneEncryptedStreamElement	許すs to get readonly copy of a child encrypted stream with password.
copyLastCommitTo	許すs to get copy of this 貯蔵 at the 明言する／公表する of it's last commit.
copyStorageElementLastCommitTo	許すs to get copy of a child 貯蔵 at the 明言する／公表する of it's last commit.
isStreamElement	許すs to check if an element is a child stream with 明示するd 指名する.
isStorageElement	許すs to check if an element is a child 貯蔵 with 明示するd 指名する.
removeElement	除去するs an element from a 貯蔵.
renameElement	改名するs an element in a 貯蔵.
copyElementTo	許すs to copy an 入ること／参加（者） from one 貯蔵 to another.
moveElementTo	許すs to move an 入ること／参加（者） from one 貯蔵 to another.

Methods' 詳細（に述べる）s

copyToStorage

無効の
copyToStorage(	[in] XStorage	xDest )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description: 許すs to copy 現在の貯蔵 to another one; The 目的地貯蔵 contents are overwritten. After the successful copying the 的貯蔵 is automatically 送るd if it 器具／実施するs transacted 接近.
Parameter xDest: a 目的地貯蔵 this 貯蔵 must be copied to.
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for any 推論する／理由
Throws: ::com::sun::星／主役にする::lang::IllegalArgumentException an 違法な argument is 供給するd
Throws: ::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during copying
Throws: ::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exception acquired during copying

openStreamElement

::com::sun::星／主役にする::io::XStream
openStreamElement(	[in] string	sStreamName,
	[in] long	nOpenMode )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::一括s::WrongPasswordException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description: 許すs to get 接近 to a child stream of the 貯蔵.; In 事例／患者 the stream is open in readonly 方式 the XStream::getOutputStream method will return an empty 言及／関連.
Parameter sStreamName: the 指名する of the substream that should be open
Parameter nOpenMode: a 方式 the stream should be open in, can be a combination of ElementModes values
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for any 推論する／理由
Throws: ::com::sun::星／主役にする::lang::IllegalArgumentException one of 供給するd arguments is 違法な
Throws: ::com::sun::星／主役にする::一括s::WrongPasswordException the 供給するd password is wrong
Throws: ::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during stream 開始
Throws: ::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exceptions

openEncryptedStreamElement

::com::sun::星／主役にする::io::XStream
openEncryptedStreamElement(	[in] string	sStreamName,
	[in] long	nOpenMode,
	[in] string	sPassword )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::一括s::NoEncryptionException, ::com::sun::星／主役にする::一括s::WrongPasswordException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description

許すs to get 接近 to a child encrypted stream with password.

If 貯蔵 does not 許す any encryption this method will always throw ::com::sun::星／主役にする::一括s::NoEncryptionException.

In 事例／患者 the stream is open in readonly 方式 the XStream::getOutputStream method will return an empty 言及／関連.

Parameter sStreamName

the 指名する of the substream that should be open

Parameter nOpenMode

a 方式 the stream should be open in, can be a combination of ElementModes values

Parameter sPassword

this parameter 許すs to 明示する a reading password for the stream, the password must be a 訂正する one, さもなければ an exception will be thrown

Throws

::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for any 推論する／理由

Throws

::com::sun::星／主役にする::lang::IllegalArgumentException one of 供給するd arguments is 違法な

Throws

::com::sun::星／主役にする::一括s::NoEncryptionException the stream is not encrypted

Throws

::com::sun::星／主役にする::一括s::WrongPasswordException the 供給するd password is wrong

Throws

::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during stream 開始

Throws

::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exceptions

openStorageElement

XStorage
openStorageElement(	[in] string	sStorName,
	[in] long	nOpenMode )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description: 許すs to get 接近 to a child 貯蔵.; The opened substorage must support 明示するd in 'nOpenMode' 接近方式s. It can support 'read' 方式 in 新規加入. But any child element can support one of those 方式s only in 事例／患者 this 方式 is supported by parent 貯蔵.
Parameter sStorName: the 指名する of the 貯蔵 that should be open
Parameter nOpenMode: a 方式 the 貯蔵 should be open in
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for any 推論する／理由
Throws: ::com::sun::星／主役にする::lang::IllegalArgumentException one of 供給するd arguments is 違法な
Throws: ::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during stream 開始
Throws: ::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exceptions

cloneStreamElement

::com::sun::星／主役にする::io::XStream
cloneStreamElement(	[in] string	sStreamName )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::一括s::WrongPasswordException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description: 許すs to get readonly copy of a child stream of the 貯蔵.; The stream is open in readonly 方式 so the XStream::getOutputStream method will return an empty 言及／関連.
Parameter sStreamName: the 指名する of the substream that should be copied
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for any 推論する／理由
Throws: ::com::sun::星／主役にする::lang::IllegalArgumentException one of 供給するd arguments is 違法な
Throws: ::com::sun::星／主役にする::一括s::WrongPasswordException the 供給するd password is wrong
Throws: ::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during stream 開始
Throws: ::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exceptions

cloneEncryptedStreamElement

::com::sun::星／主役にする::io::XStream
cloneEncryptedStreamElement(	[in] string	sStreamName,
	[in] string	sPassword )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::一括s::NoEncryptionException, ::com::sun::星／主役にする::一括s::WrongPasswordException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description

許すs to get readonly copy of a child encrypted stream with password.

If 貯蔵 does not 許す any encryption this method will always throw ::com::sun::星／主役にする::一括s::NoEncryptionException.

The stream is open in readonly 方式 so the XStream::getOutputStream method will return an empty 言及／関連.

This method 許すs to 明示する reading password for the child stream explicitly.

Parameter sStreamName

the 指名する of the substream that should be copied

Parameter sPassword

this parameter 許すs to 明示する a reading password for the stream, the password must be a 訂正する one, さもなければ an exception will be thrown

Throws

::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for any 推論する／理由

Throws

::com::sun::星／主役にする::lang::IllegalArgumentException one of 供給するd arguments is 違法な

Throws

::com::sun::星／主役にする::一括s::NoEncryptionException the stream is not encrypted

Throws

::com::sun::星／主役にする::一括s::WrongPasswordException the 供給するd password is wrong

Throws

::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during stream 開始

Throws

::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exceptions

copyLastCommitTo

無効の
copyLastCommitTo(	[in] XStorage	xTargetStorage )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description: 許すs to get copy of this 貯蔵 at the 明言する／公表する of it's last commit.; This method makes sence only for services 実施s that 許す処理／取引 in the 貯蔵.
Parameter xStorage: the 的貯蔵 that will be filled in with copy.
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for any 推論する／理由
Throws: ::com::sun::星／主役にする::lang::IllegalArgumentException one of 供給するd arguments is 違法な
Throws: ::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during copying
Throws: ::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exceptions

copyStorageElementLastCommitTo

無効の
copyStorageElementLastCommitTo(	[in] string	sStorName,
	[in] XStorage	xTargetStorage )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description: 許すs to get copy of a child 貯蔵 at the 明言する／公表する of it's last commit.; This method makes sence only for services 実施s that 許す処理／取引 in the 貯蔵.
Parameter sStorName: the 指名する of the 貯蔵 that should be copied
Parameter xStorage: the 的貯蔵 that will be filled in with copy
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for any 推論する／理由
Throws: ::com::sun::星／主役にする::lang::IllegalArgumentException one of 供給するd arguments is 違法な
Throws: ::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during copying
Throws: ::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exceptions

isStreamElement

boolean
isStreamElement(	[in] string	sElementName )
raises(	::com::sun::星／主役にする::コンテナ::NoSuchElementException, ::com::sun::星／主役にする::lang::IllegalArgumentException, InvalidStorageException );

Description: 許すs to check if an element is a child stream with 明示するd 指名する.; In 事例／患者 there is no child element with such 指名する an exception will be thrown.
Parameter sElementName: the 指名する of the element to check
Returns: true in 事例／患者 the element is a stream 誤った - the element is a 貯蔵
Throws: ::com::sun::星／主役にする::コンテナ::NoSuchElementException there is no element with such 指名する
Throws: ::com::sun::星／主役にする::lang::IllegalArgumentException an 違法な argument is 供給するd
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for any 推論する／理由

isStorageElement

boolean
isStorageElement(	[in] string	sElementName )
raises(	::com::sun::星／主役にする::コンテナ::NoSuchElementException, ::com::sun::星／主役にする::lang::IllegalArgumentException, InvalidStorageException );

Description: 許すs to check if an element is a child 貯蔵 with 明示するd 指名する.; In 事例／患者 there is no child element with such 指名する an exception will be thrown.
Parameter sElementName: the 指名する of the element to check
Returns: true in 事例／患者 the element is a 貯蔵 誤った - the element is a stream
Throws: ::com::sun::星／主役にする::コンテナ::NoSuchElementException there is no element with such 指名する
Throws: ::com::sun::星／主役にする::lang::IllegalArgumentException an 違法な argument is 供給するd
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for any 推論する／理由

removeElement

無効の
removeElement(	[in] string	sElementName )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::コンテナ::NoSuchElementException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description: 除去するs an element from a 貯蔵.
Parameter sElementName: the 指名する of the element to 除去する
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for eny 推論する／理由
Throws: ::com::sun::星／主役にする::lang::IllegalArgumentException an 違法な argument is 供給するd
Throws: ::com::sun::星／主役にする::コンテナ::NoSuchElementException there is no element with such 指名する
Throws: ::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during 除去するing
Throws: ::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exceptions

renameElement

無効の
renameElement(	[in] string	sElementName,
	[in] string	sNewName )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::コンテナ::NoSuchElementException, ::com::sun::星／主役にする::コンテナ::ElementExistException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description: 改名するs an element in a 貯蔵.
Parameter sElementName: the old 指名する of the element to 改名する
Parameter sNewName: the new 指名する of the element to 改名する
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for eny 推論する／理由
Throws: ::com::sun::星／主役にする::lang::IllegalArgumentException an 違法な argument is 供給するd
Throws: ::com::sun::星／主役にする::コンテナ::NoSuchElementException there is no element with old 指名する in this 貯蔵
Throws: ::com::sun::星／主役にする::コンテナ::ElementExistException an element with new 指名する already 存在するs in this 貯蔵
Throws: ::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during 改名するing
Throws: ::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exceptions

copyElementTo

無効の
copyElementTo(	[in] string	sElementName,
	[in] XStorage	xDest,
	[in] string	sNewName )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::コンテナ::NoSuchElementException, ::com::sun::星／主役にする::コンテナ::ElementExistException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description: 許すs to copy an 入ること／参加（者） from one 貯蔵 to another.; If 的 element supports transacted 方式 it must be 送るd by this method after successful copying.
Parameter sElementName: the 指名する of the element in this 貯蔵
Parameter xDest: a 目的地貯蔵
Parameter sNewName: the 指名する of the result element in 目的地貯蔵
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for eny 推論する／理由
Throws: ::com::sun::星／主役にする::コンテナ::NoSuchElementException there is no 明示するd source element in this 貯蔵
Throws: ::com::sun::星／主役にする::コンテナ::ElementExistException an element with 明示するd 目的地指名する already 存在するs in 目的地貯蔵
Throws: ::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during copying
Throws: ::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exceptions

moveElementTo

無効の
moveElementTo(	[in] string	sElementName,
	[in] XStorage	xDest,
	[in] string	sNewName )
raises(	InvalidStorageException, ::com::sun::星／主役にする::lang::IllegalArgumentException, ::com::sun::星／主役にする::コンテナ::NoSuchElementException, ::com::sun::星／主役にする::コンテナ::ElementExistException, ::com::sun::星／主役にする::io::IOException, StorageWrappedTargetException );

Description: 許すs to move an 入ること／参加（者） from one 貯蔵 to another.; If 的 element supports transacted 方式 it must be 送るd by this method after successful moving.
Parameter sElementName: the 指名する of the element in this 貯蔵
Parameter xDest: a 目的地貯蔵
Parameter sNewName: the 指名する of the result element in 目的地貯蔵
Throws: ::com::sun::星／主役にする::embed::InvalidStorageException this 貯蔵 is in 無効の明言する／公表する for eny 推論する／理由
Throws: ::com::sun::星／主役にする::コンテナ::NoSuchElementException there is no 明示するd source element in this 貯蔵
Throws: ::com::sun::星／主役にする::コンテナ::ElementExistException an element with 明示するd 目的地指名する already 存在するs in 目的地貯蔵
Throws: ::com::sun::星／主役にする::io::IOException in 事例／患者 of io errors during moving
Throws: ::com::sun::星／主役にする::embed::StorageWrappedTargetException 包むs other exceptions

最高の，を越す of Page

Copyright © 2013, The Apache ソフトウェア創立／基礎, Licensed under the Apache License, 見解／翻訳／版 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache ソフトウェア創立／基礎. Other 指名するs may be trademarks of their 各々の owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous