View Javadoc

1   /**
2    * This file Copyright (c) 2011-2012 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.jcr.iterator;
35  
36  import info.magnolia.jcr.decoration.ContentDecorator;
37  import info.magnolia.jcr.wrapper.NodeWrapperFactory;
38  
39  import javax.jcr.Node;
40  import javax.jcr.NodeIterator;
41  
42  /**
43   * Node iterator wrapping all returned nodes using provided node wrapper.
44   */
45  public class WrappingNodeIterator extends DelegatingNodeIterator {
46  
47      /**
48       * @deprecated since 4.5.9 since 4.5.9 use {@link ContentDecorator} instead
49       */
50      private NodeWrapperFactory wrapperFactory;
51      private ContentDecorator decorator;
52  
53      public WrappingNodeIterator(NodeIterator iterator, ContentDecorator decorator) {
54          super(iterator);
55          this.decorator = decorator;
56      }
57  
58      /**
59       * @deprecated since 4.5.9 use {@link WrappingNodeIterator#WrappingNodeIterator(NodeIterator, ContentDecorator)}
60       */
61      public WrappingNodeIterator(NodeIterator iterator, NodeWrapperFactory wrapperFactory) {
62          super(iterator);
63          this.wrapperFactory = wrapperFactory;
64      }
65  
66      @Override
67      public Object next() {
68          return wrapNode((Node) super.next());
69      }
70  
71      @Override
72      public Node nextNode() {
73          return wrapNode(super.nextNode());
74      }
75  
76      protected Node wrapNode(Node node) {
77          if (this.decorator != null) {
78              return decorator.wrapNode(node);
79          } else if (this.wrapperFactory != null) {
80              return wrapperFactory.wrapNode(node);
81          }
82          return node;
83      }
84  }