1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.store.filesystem.internal

File AttachmentFileProvider.java

 

Code metrics

0
0
0
1
52
8
0
-
-
0
-

Classes

Class Line # Actions
AttachmentFileProvider 30 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

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.store.filesystem.internal;
21   
22    import java.io.File;
23   
24    /**
25    * A means of getting files for storing information about a given attachment.
26    *
27    * @version $Id: 03a3af7e3f29ee259c00b32c45689138ea13d2dc $
28    * @since 3.0M2
29    */
 
30    public interface AttachmentFileProvider
31    {
32    /**
33    * @return the File for storing the latest version of the attachment's content.
34    */
35    File getAttachmentContentFile();
36   
37    /**
38    * Get the meta file for the attachment.
39    * The meta file contains information about each version of the attachment such as who saved it.
40    *
41    * @return the File for storing meta data for each version of an attachment.
42    */
43    File getAttachmentVersioningMetaFile();
44   
45    /**
46    * Get a uniquely named file for storing a perticular version of the attachment.
47    *
48    * @param versionName the name of the version of the attachment eg: "1.1" or "1.2"
49    * @return the File for storing the content of a particular version of the attachment.
50    */
51    File getAttachmentVersionContentFile(String versionName);
52    }