VfsPathFactory.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.vfs;

import java.net.URI;
import java.nio.file.Path;

import org.xwiki.component.annotation.Role;
import org.xwiki.stability.Unstable;

/**
 * Helper to create a {@link Path} instance from an XWiki VFS URI
 * (e.g. {@code attach:Sandbox.WebHome@my.zip/some/path}).
 *
 * @version $Id: c788d7527b6e73b6dd6aec9cb22e07401a8b0408 $
 * @since 8.4RC1
 */
@Role
@Unstable
public interface VfsPathFactory
{
    /**
     * @param uri the XWiki VFS URI (e.g. {@code attach:Sandbox.WebHome@my.zip/some/path})
     * @return the corresponding NIO2 {@link Path} instance
     * @throws VfsException if the URI is not valid or the user doesn't have permissions to access it
     */
    Path create(URI uri) throws VfsException;
}