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

File UserAvatarAttachmentExtractor.java

 

Code metrics

0
0
0
1
57
10
0
-
-
0
-

Classes

Class Line # Actions
UserAvatarAttachmentExtractor 37 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.watchlist.internal;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.model.reference.DocumentReference;
24   
25    import com.xpn.xwiki.api.Attachment;
26   
27    /**
28    * Get the user's avatar if it is set. If not, get the standard "noAvatar.png" image.
29    * <p>
30    * In both cases, the resulting image will be resized to a thumbnail version and it will have a fixed name. The
31    * resulting {@link Attachment} object will be a fake as to not affect live documents.
32    *
33    * @version $Id: 01df66443332ae2bdf293c9a8c0271a0985af2a7 $
34    * @since 7.1RC1
35    */
36    @Role
 
37    public interface UserAvatarAttachmentExtractor
38    {
39    /**
40    * @param userReference the document reference to the profile of the user from which to extract the avatar
41    * @return a n {@link Attachment} instance containing the user's avatar or the default ("noavatar.png") image. The
42    * returned instance is a fake as to not affect live documents. Also, the file is resized and renamed to
43    * default values (i.e. 50px, 50px, "<prefixedFullUserName>.png")
44    */
45    Attachment getUserAvatar(DocumentReference userReference);
46   
47    /**
48    * @param userReference the document reference to the profile of the user from which to extract the avatar
49    * @param width the width, in pixels, of the user's resized avatar image
50    * @param height the height, in pixels, of the user's resized avatar image
51    * @param fileName the name of the user's resized avatar image
52    * @return an {@link Attachment} instance containing the user's avatar or the default ("noavatar.png") image. The
53    * returned instance is a fake as to not affect live documents. Also, the file is resized and renamed to the
54    * specified values.
55    */
56    Attachment getUserAvatar(DocumentReference userReference, int width, int height, String fileName);
57    }