Package org.xwiki.annotation.io

Interface IOTargetService

@Role
public interface IOTargetService

This service provides functions to operate with annotations targets. It operates with string serialized references to such targets. This interface does not restrict the implementation of the annotation targets, they can be anything referencable through a string.

Since:

2.3M1

Version:

$Id: ac15187a80d4ad82fdcc2db95ff84571948a1abe $

Method Summary

Modifier and Type	Method	Description
String	getSource(String reference)	Deprecated. use getXDOM(String)
String	getSourceSyntax(String reference)
org.xwiki.rendering.block.XDOM	getXDOM(String reference)
org.xwiki.rendering.block.XDOM	getXDOM(String reference, String syntax)

Method Detail

getSource

@Deprecated
String getSource(String reference)
          throws IOServiceException

Deprecated.

use getXDOM(String)

Parameters:

reference - serialized string reference of the content to get the source for

Returns:

the source of the referenced content

Throws:

IOServiceException - if any exception occurs when manipulating sources

getSourceSyntax

String getSourceSyntax(String reference)
                throws IOServiceException

Parameters:

reference - serialized string reference of the content whose syntax to return

Returns:

the syntax of the source of the referenced content

Throws:

IOServiceException - if any exception occurs when manipulating sources

getXDOM

org.xwiki.rendering.block.XDOM getXDOM(String reference)
                                throws IOServiceException

Parameters:

reference - serialized string reference of the content to get the XDOM for

Returns:

the XDOM of the referenced content

Throws:

IOServiceException - if any exception occurs when manipulating sources

Since:

6.2 TODO: While we use String for reference to stay in the style of the existing API, it would be better to use EntityReference when this API get more largely refactored.

getXDOM

org.xwiki.rendering.block.XDOM getXDOM(String reference,
                                       String syntax)
                                throws IOServiceException

Parameters:

reference - serialized string reference of the content to get the XDOM for

syntax - the syntax of the source of the referenced content

Returns:

the XDOM of the referenced content

Throws:

IOServiceException - if any exception occurs when manipulating sources

Since:

6.2 TODO: While we use String for reference and syntax to stay in the style of the existing API, it would be better to use EntityReference and SyntaxId when this API get more largely refactored.