org.modelio.metamodel.uml.infrastructure

Interface IResourceHandle

public interface IResourceHandle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BLOB_LOCAL_KEY

Method Summary

Modifier and Type	Method and Description
static void	copy(IResourceHandle src, IResourceHandle target) Copy the attached resource content between 2 model objects.
java.nio.file.Path	extractInto(java.nio.file.Path dir) Copy the resource in a file in the given directory.
java.net.URI	getLocation() Get the location of the resource.
java.io.InputStream	read() Open a read stream.
void	setAuthenticationData(org.modelio.vbasic.auth.IAuthData auth) Set the authentication data that may be needed to access the resource.
java.io.OutputStream	write() Open a write stream on the resource.

Field Detail

BLOB_LOCAL_KEY

static final java.lang.String BLOB_LOCAL_KEY

See Also:

Constant Field Values

Method Detail

read

java.io.InputStream read()
                  throws java.io.IOException

Open a read stream.

The caller has to close the stream, usually with a try-with-resource statement.

Returns:

the read stream.

Throws:

java.io.IOException - on I/O failure.

write

java.io.OutputStream write()
                    throws java.io.IOException

Open a write stream on the resource.

The caller has to close the stream, usually with a try-with-resource statement.

Returns:

the writing stream.

Throws:

java.io.IOException - on I/O failure.

setAuthenticationData

void setAuthenticationData(org.modelio.vbasic.auth.IAuthData auth)

Set the authentication data that may be needed to access the resource.

Parameters:

auth - the authentication data.

extractInto

java.nio.file.Path extractInto(java.nio.file.Path dir)
                        throws java.io.IOException

Copy the resource in a file in the given directory.

Parameters:

dir - the target directory.

Returns:

the file containing the resource.

Throws:

java.io.IOException - the created file.

copy

static void copy(IResourceHandle src,
                 IResourceHandle target)
          throws java.io.IOException

Copy the attached resource content between 2 model objects.

Beware the target resource content will be overwritten, even if it the resource was an external reference.

Parameters:

src - the source resource handle.

target - the target resource handle.

Throws:

java.io.IOException - on I/O failure

getLocation

java.net.URI getLocation()

Get the location of the resource.

Returns null for an embedded resource.

Returns:

the location of the resource.