View Javadoc
1   /**
2    * This file Copyright (c) 2011-2018 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.PropertyWrapperFactory;
38  
39  import javax.jcr.Property;
40  import javax.jcr.PropertyIterator;
41  
42  /**
43   * Property iterator wrapping all returned nodes using provided property wrapper.
44   */
45  public class WrappingPropertyIterator extends DelegatingPropertyIterator {
46  
47      /**
48       * @deprecated since 4.5.9 use {@link ContentDecorator} instead
49       */
50      @Deprecated
51      private PropertyWrapperFactory wrapperFactory;
52      private ContentDecorator decorator;
53  
54      public WrappingPropertyIterator(PropertyIterator iterator, ContentDecorator decorator) {
55          super(iterator);
56          this.decorator = decorator;
57      }
58  
59      /**
60       * @deprecated since 4.5.9 use {@link WrappingPropertyIterator#WrappingPropertyIterator(PropertyIterator, ContentDecorator)} instead
61       */
62      @Deprecated
63      public WrappingPropertyIterator(PropertyIterator iterator, PropertyWrapperFactory wrapperFactory) {
64          super(iterator);
65          this.wrapperFactory = wrapperFactory;
66      }
67  
68      @Override
69      public Object next() {
70          return wrapProperty((Property) super.next());
71      }
72  
73      @Override
74      public Property nextProperty() {
75          return wrapProperty(super.nextProperty());
76      }
77  
78      protected Property wrapProperty(Property property) {
79          if (decorator != null) {
80              return decorator.wrapProperty(property);
81          } else if (wrapperFactory != null) {
82              return wrapperFactory.wrapProperty(property);
83          } else {
84              return property;
85          }
86      }
87  }