org.modelio.metamodel.mmextensions.infrastructure

Interface IResourceBuilder

public interface IResourceBuilder

Attached resource element builder.

Builds Document and Resource elements.

Since:

3.7

Author:

cma

Method Summary

Modifier and Type	Method and Description
Document	createDocumentReference()
Document	createEmbeddedDocument() Creates the embedded document.
Resource	createEmbeddedResource() Creates the embedded resource.
Resource	createResourceReference()
IResourceBuilder	withAuthData(org.modelio.vbasic.auth.IAuthData auth) use the given authentication data to at least probe the content type.
IResourceBuilder	withFile(java.nio.file.Path file)
IResourceBuilder	withMimeType(java.lang.String mimeType)
IResourceBuilder	withName(java.lang.String name)
IResourceBuilder	withOwner(ModelElement owner)
IResourceBuilder	withRole(ResourceType type)
IResourceBuilder	withRole(java.lang.String moduleName, java.lang.String ownerName, java.lang.String typeName) Set the resource role.
IResourceBuilder	withURI(java.net.URI uri)

Method Detail

createDocumentReference

Document createDocumentReference()

Returns:

the created document.

createEmbeddedDocument

Document createEmbeddedDocument()
                         throws java.io.IOException

Creates the embedded document.

Returns:

the created document.

Throws:

java.io.IOException - if embedding fails with an I/O error.

createEmbeddedResource

Resource createEmbeddedResource()
                         throws java.io.IOException

Creates the embedded resource.

Returns:

the created resource.

Throws:

java.io.IOException - if embedding fails with an I/O error.

createResourceReference

Resource createResourceReference()

Returns:

the created resource.

withFile

IResourceBuilder withFile(java.nio.file.Path file)

Parameters:

file - the represented file path

Returns:

this builder.

withMimeType

IResourceBuilder withMimeType(java.lang.String mimeType)

Parameters:

mimeType - the resource MIME type.

Returns:

withName

IResourceBuilder withName(java.lang.String name)

Parameters:

name - The resource title.

Returns:

this instance.

withOwner

IResourceBuilder withOwner(ModelElement owner)

withRole

IResourceBuilder withRole(java.lang.String moduleName,
                          java.lang.String ownerName,
                          java.lang.String typeName)
                   throws ExtensionNotFoundException,
                          java.lang.IllegalStateException

Set the resource role.

Parameters:

moduleName - the module name or regex pattern

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

typeName - the role name

Returns:

this builder

Throws:

ExtensionNotFoundException - if the role was not found.

java.lang.IllegalStateException - if withOwner(ModelElement) was not called before.

withRole

IResourceBuilder withRole(ResourceType type)

Parameters:

type - the resource role.

Returns:

this instance.

withURI

IResourceBuilder withURI(java.net.URI uri)

Parameters:

uri - the represented resource URI.

Returns:

this instance.

withAuthData

IResourceBuilder withAuthData(org.modelio.vbasic.auth.IAuthData auth)

use the given authentication data to at least probe the content type.

The password will never be stored in any case. The current implementation does not store the authentication data.

Parameters:

auth - authentication data.

Returns:

this builder.

Since:

3.7.1