1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.macro.context

File ContextMacroParameters.java

 

Coverage histogram

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

Code metrics

0
4
4
1
83
26
4
1
1
4
1

Classes

Class Line # Actions
ContextMacroParameters 30 4 0% 4 0
1.0100%
 

Contributing tests

This file is covered by 6 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.rendering.macro.context;
21   
22    import org.xwiki.properties.annotation.PropertyDescription;
23   
24    /**
25    * Parameters for the Context macro.
26    *
27    * @version $Id: 4ddf2beca77f241e001a8b71f783ce5185d88ac3 $
28    * @since 3.0M1
29    */
 
30    public class ContextMacroParameters
31    {
32    /**
33    * @see #getDocument()
34    */
35    private String documentReference;
36   
37    /**
38    * @see #getTransformationContext()
39    * @since 8.3
40    * @since 8.4RC1
41    */
42    private TransformationContextMode transformationContextMode = TransformationContextMode.CURRENT;
43   
44    /**
45    * @return the reference to the document that will be set as the current document to evaluate the macro's content
46    */
 
47  21 toggle public String getDocument()
48    {
49  21 return this.documentReference;
50    }
51   
52    /**
53    * @param documentReference refer to {@link #getDocument()}
54    */
 
55  5 toggle @PropertyDescription("The reference to the document serving as the current document")
56    public void setDocument(String documentReference)
57    {
58  5 this.documentReference = documentReference;
59    }
60   
61    /**
62    * @return the mode to use for setting the Transformation Context in which the Context Macro will execute, see
63    * {@link TransformationContextMode} for details
64    * @since 8.3
65    * @since 8.4RC1
66    */
 
67  10 toggle public TransformationContextMode getTransformationContext()
68    {
69  10 return this.transformationContextMode;
70    }
71   
72    /**
73    * @param mode refer to {@link #getTransformationContext()}
74    * @since 8.3
75    * @since 8.4RC1
76    */
 
77  1 toggle @PropertyDescription("The Transformation Context mode to use. "
78    + "Valid values are \"current\", \"document\" and \"transformations\"")
79    public void setTransformationContext(TransformationContextMode mode)
80    {
81  1 this.transformationContextMode = mode;
82    }
83    }