Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
VfsPathFactory | 37 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.vfs; | |
21 | ||
22 | import java.net.URI; | |
23 | import java.nio.file.Path; | |
24 | ||
25 | import org.xwiki.component.annotation.Role; | |
26 | import org.xwiki.stability.Unstable; | |
27 | ||
28 | /** | |
29 | * Helper to create a {@link Path} instance from an XWiki VFS URI | |
30 | * (e.g. {@code attach:Sandbox.WebHome@my.zip/some/path}). | |
31 | * | |
32 | * @version $Id: c788d7527b6e73b6dd6aec9cb22e07401a8b0408 $ | |
33 | * @since 8.4RC1 | |
34 | */ | |
35 | @Role | |
36 | @Unstable | |
37 | public interface VfsPathFactory | |
38 | { | |
39 | /** | |
40 | * @param uri the XWiki VFS URI (e.g. {@code attach:Sandbox.WebHome@my.zip/some/path}) | |
41 | * @return the corresponding NIO2 {@link Path} instance | |
42 | * @throws VfsException if the URI is not valid or the user doesn't have permissions to access it | |
43 | */ | |
44 | Path create(URI uri) throws VfsException; | |
45 | } |