IOTargetService.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.annotation.io;

import org.xwiki.component.annotation.Role;
import org.xwiki.rendering.block.XDOM;

/**
 * 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.
 *
 * @version $Id: ac15187a80d4ad82fdcc2db95ff84571948a1abe $
 * @since 2.3M1
 */
@Role
public interface IOTargetService
{
    /**
     * @param reference serialized string reference of the content to get the source for
     * @return the source of the referenced content
     * @throws IOServiceException if any exception occurs when manipulating sources
     * @deprecated use {@link #getXDOM(String)}
     */
    @Deprecated
    String getSource(String reference) throws IOServiceException;

    /**
     * @param reference serialized string reference of the content whose syntax to return
     * @return the syntax of the source of the referenced content
     * @throws IOServiceException if any exception occurs when manipulating sources
     */
    String getSourceSyntax(String reference) throws IOServiceException;

    /**
     * @param reference serialized string reference of the content to get the XDOM for
     * @return 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.
     */
    XDOM getXDOM(String reference) throws IOServiceException;

    /**
     * @param reference serialized string reference of the content to get the XDOM for
     * @param syntax the syntax of the source of the referenced content
     * @return 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.
     */
    XDOM getXDOM(String reference, String syntax) throws IOServiceException;
}