Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
VfsManager	31	0	-	0	0	-1.0 -	Show methods

Class VfsManager

Class VfsManager	Line # 31	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

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 org.xwiki.component.annotation.Role;
23
24		/**
25		* API to construct a VFS URL or access the content of an archive.
26		*
27		* @version $Id: cf37e382f94c0d2741412e459dd40d35efc15b34 $
28		* @since 7.4M2
29		*/
30		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
31		public interface VfsManager
32		{
33		/**
34		* Generate a relative VFS URL to access a resource inside an archive.
35		*
36		* @param reference the reference to a file inside a an archive.
37		* For example {@code attach:space.page@my.zip/path/to/file}.
38		* @return a relative URL that can be used to access the content of a file inside an archive (ZIP, EAR, TAR.GZ, etc)
39		* @exception VfsException if an error occurs computing the URL
40		*/
41		String getURL(VfsResourceReference reference) throws VfsException;
42		}