-
Notifications
You must be signed in to change notification settings - Fork 78
/
XDOM.java
124 lines (111 loc) · 3.78 KB
/
XDOM.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.rendering.block;
import org.xwiki.rendering.listener.Listener;
import org.xwiki.rendering.listener.MetaData;
import org.xwiki.rendering.util.IdGenerator;
import java.util.List;
import java.util.Collections;
/**
* Contains the full tree of {@link Block} that represent a XWiki Document's content.
*
* @version $Id$
* @since 1.5M2
*/
public class XDOM extends MetaDataBlock
{
/**
* Constructs an empty XDOM. Useful for example when calling a macro that doesn't use the XDOM parameter passed to
* it.
*/
public static final XDOM EMPTY = new XDOM(Collections.<Block> emptyList());
/**
* Stateful id generator for this document. We store it in the XDOM because it is the only object which remains the
* same between parsing, transformation and rendering, and we need to generate ids during parsing and during
* transformation.
*/
private IdGenerator idGenerator;
/**
* @param childBlocks the list of children blocks of the block to construct
* @see AbstractBlock#AbstractBlock(List)
*/
public XDOM(List<Block> childBlocks)
{
this(childBlocks, new IdGenerator(), MetaData.EMPTY);
}
/**
* @param childBlocks the list of children blocks of the block to construct
* @param metaData the meta data to add for this block
* @see AbstractBlock#AbstractBlock(List)
*/
public XDOM(List<Block> childBlocks, MetaData metaData)
{
this(childBlocks, new IdGenerator(), metaData);
}
/**
* @param childBlocks the list of children blocks of the block to construct
* @param idGenerator a stateful id generator for this document
*/
public XDOM(List<Block> childBlocks, IdGenerator idGenerator)
{
this(childBlocks, idGenerator, MetaData.EMPTY);
}
/**
* @param childBlocks the list of children blocks of the block to construct
* @param metaData the meta data to add for this block
* @param idGenerator a stateful id generator for this document
* @see AbstractBlock#AbstractBlock(List)
*/
public XDOM(List<Block> childBlocks, IdGenerator idGenerator, MetaData metaData)
{
super(childBlocks, metaData);
this.idGenerator = idGenerator;
}
/**
* @return a stateful id generator for the whole document.
*/
public IdGenerator getIdGenerator()
{
return this.idGenerator;
}
/**
* @param idGenerator a stateful id generator for the whole document.
* @since 2.1M1
*/
public void setIdGenerator(IdGenerator idGenerator)
{
this.idGenerator = idGenerator;
}
@Override
public void before(Listener listener)
{
listener.beginDocument(getMetaData());
}
@Override
public void after(Listener listener)
{
listener.endDocument(getMetaData());
}
@Override
public XDOM clone()
{
return (XDOM) super.clone();
}
}