SpaceReferenceResolver.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.model.reference;

import java.lang.reflect.ParameterizedType;

import org.xwiki.component.annotation.Role;
import org.xwiki.component.util.DefaultParameterizedType;

/**
 * Resolve a Space reference defined in a given representation into a validated {@link SpaceReference} object, ie with
 * valid values and a valid hierarchy (eg a Space reference must have a parent which is a space reference or a wiki
 * reference, reference values must not be null, etc).
 * 
 * @version $Id: 27afc8a6f0f7d9b17646ca271fb0aca91f5af64a $
 * @since 7.2M1
 * @param <T> the type of the representation (eg a String)
 */
@Role
public interface SpaceReferenceResolver<T>
{
    /**
     * Type instance for {@code SpaceReferenceResolver<String>}.
     */
    ParameterizedType TYPE_STRING = new DefaultParameterizedType(null, SpaceReferenceResolver.class, String.class);

    /**
     * Type instance for {@code SpaceReferenceResolver<EntityReference>}.
     */
    ParameterizedType TYPE_REFERENCE = new DefaultParameterizedType(null, SpaceReferenceResolver.class,
        EntityReference.class);

    /**
     * @param spaceReferenceRepresentation the representation of a space reference (eg as a String)
     * @param parameters optional parameters. Their meaning depends on the resolver implementation
     * @return the valid resolved space reference as an Object
     */
    SpaceReference resolve(T spaceReferenceRepresentation, Object... parameters);
}