1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package com.xpn.xwiki.internal.mandatory

File XWikiSkinFileOverrideClassDocumentInitializer.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart10.png
0% of files have more coverage

Code metrics

0
7
2
1
82
33
2
0.29
3.5
2
1

Classes

Class Line # Actions
XWikiSkinFileOverrideClassDocumentInitializer 43 7 0% 2 0
1.0100%
 

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 com.xpn.xwiki.internal.mandatory;
21   
22    import javax.inject.Named;
23    import javax.inject.Singleton;
24   
25    import org.xwiki.component.annotation.Component;
26    import org.xwiki.model.reference.EntityReference;
27    import org.xwiki.model.reference.LocalDocumentReference;
28   
29    import com.xpn.xwiki.XWiki;
30    import com.xpn.xwiki.doc.XWikiDocument;
31    import com.xpn.xwiki.objects.classes.BaseClass;
32   
33    /**
34    * Update XWiki.XWikiSkinFileOverrideClass document with all required properties. This XClass is used to override a skin
35    * file by attaching an instance of it to the skin document.
36    *
37    * @version $Id: a2384ac0d122574e0703453dba5a1625a9b077e5 $
38    * @since 7.0RC1
39    */
40    @Component
41    @Named("XWiki.XWikiSkinFileOverrideClass")
42    @Singleton
 
43    public class XWikiSkinFileOverrideClassDocumentInitializer extends AbstractMandatoryDocumentInitializer
44    {
45    /**
46    * The reference to the mandatory document.
47    */
48    public static final EntityReference DOCUMENT_REFERENCE
49    = new LocalDocumentReference(XWiki.SYSTEM_SPACE, "XWikiSkinFileOverrideClass");
50   
51    /**
52    * The name of the property storing the path of the file to overwrite.
53    */
54    public static final String PROPERTY_PATH = "path";
55   
56    /**
57    * The name of the property holding the content.
58    */
59    public static final String PROPERTY_CONTENT = "content";
60   
61    /**
62    * Default constructor.
63    */
 
64  60 toggle public XWikiSkinFileOverrideClassDocumentInitializer()
65    {
66  60 super(DOCUMENT_REFERENCE);
67    }
68   
 
69  92 toggle @Override
70    public boolean updateDocument(XWikiDocument document)
71    {
72  92 boolean needsUpdate = false;
73   
74  92 BaseClass bclass = document.getXClass();
75   
76  92 needsUpdate |= bclass.addTextField(PROPERTY_PATH, "Path", 255);
77  92 needsUpdate |= bclass.addTemplateField(PROPERTY_CONTENT, "Content");
78  92 needsUpdate |= setClassDocumentFields(document, "XWiki Skin File Override Class");
79   
80  92 return needsUpdate;
81    }
82    }