org.apache.sling.resourcebuilder.api

Interface ResourceBuilder

All Known Implementing Classes:

ResourceBuilderImpl

public interface ResourceBuilder

Builds Sling Resources using a simple fluent API

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PRIMARY_TYPE Default primary type for resources created by this builder

Method Summary

Modifier and Type	Method and Description
ResourceBuilder	atParent() Reset the current parent Resource to the original one.
ResourceBuilder	commit() Commit created resources
ResourceBuilder	file(String filename, InputStream data) Create a file under the current parent resource.
ResourceBuilder	file(String filename, InputStream data, String mimeType, long lastModified) Create a file under the current parent resource
org.apache.sling.api.resource.Resource	getCurrentParent() Return the current parent resource
ResourceBuilder	hierarchyMode() Set hierarchy mode (as opposed to siblings mode) where creating a resource sets it as the current parent.
ResourceBuilder	resource(String path, Map<String,Object> properties) Create a Resource, which optionally becomes the current parent Resource.
ResourceBuilder	resource(String path, Object... properties) Create a Resource, which optionally becomes the current parent Resource.
ResourceBuilder	siblingsMode() Set siblings mode (as opposed to hierarchy mode) where creating a resource doesn't change the current parent.
ResourceBuilder	withIntermediatePrimaryType(String primaryType) Set the primary type for intermediate resources created when the parent of resource being created does not exist.

Field Detail

DEFAULT_PRIMARY_TYPE

static final String DEFAULT_PRIMARY_TYPE

Default primary type for resources created by this builder

See Also:

Constant Field Values

Method Detail

resource

ResourceBuilder resource(String path,
                         Object... properties)

Create a Resource, which optionally becomes the current parent Resource.

Parameters:

path - The path of the Resource to create. If it's a relative path this builder's current resource is used as parent. Otherwise the resource is created ad the given absoulte path.

properties - optional name-value pairs

Returns:

this builder

resource

ResourceBuilder resource(String path,
                         Map<String,Object> properties)

Create a Resource, which optionally becomes the current parent Resource.

Parameters:

path - The path of the Resource to create. If it's a relative path this builder's current resource is used as parent. Otherwise the resource is created ad the given absoulte path.

properties - Name-value pairs

Returns:

this builder

file

ResourceBuilder file(String filename,
                     InputStream data,
                     String mimeType,
                     long lastModified)

Create a file under the current parent resource

Parameters:

filename - The name of the created file

data - The file data

mimeType - If null, use the Sling MimeTypeService to set the mime type

lastModified - if < 0, current time is used

Returns:

this builder

file

ResourceBuilder file(String filename,
                     InputStream data)

Create a file under the current parent resource. Mime type is set using the Sling MimeTypeService, and last modified is set to current time.

Parameters:

filename - The name of the created file

data - The file data

Returns:

this builder

commit

ResourceBuilder commit()

Commit created resources

withIntermediatePrimaryType

ResourceBuilder withIntermediatePrimaryType(String primaryType)

Set the primary type for intermediate resources created when the parent of resource being created does not exist.

Parameters:

primaryType - If null the DEFAULT_PRIMARY_TYPE is used.

Returns:

this builder

siblingsMode

ResourceBuilder siblingsMode()

Set siblings mode (as opposed to hierarchy mode) where creating a resource doesn't change the current parent. Used to create flat structures. This is off by default.

Returns:

this builder

hierarchyMode

ResourceBuilder hierarchyMode()

Set hierarchy mode (as opposed to siblings mode) where creating a resource sets it as the current parent. Used to create tree structures. This is on by default.

Returns:

this builder

getCurrentParent

org.apache.sling.api.resource.Resource getCurrentParent()

Return the current parent resource

atParent

ResourceBuilder atParent()

Reset the current parent Resource to the original one. Also activates hierarchyMode which is the default mode.