View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.ui.availability.rule;
35  
36  import info.magnolia.jcr.RuntimeRepositoryException;
37  import info.magnolia.ui.api.availability.AvailabilityDefinition;
38  import info.magnolia.ui.api.availability.AvailabilityRuleDefinition;
39  
40  import javax.jcr.Item;
41  import javax.jcr.RepositoryException;
42  
43  /**
44   * Base implementation {@link info.magnolia.ui.api.availability.AvailabilityRule AvailabilityRule}
45   * for the JCR items. Main purpose is to let the rule implementor throw repository exceptions from the
46   * implementations.
47   *
48   * @param <D>
49   *     type of {@link info.magnolia.ui.api.availability.AvailabilityRuleDefinition}.
50   */
51  public abstract class AbstractJcrRule<D extends AvailabilityRuleDefinition> extends AbstractAvailabilityRule<Item, D> {
52  
53      protected AbstractJcrRule(AvailabilityDefinition availabilityDefinition, D ruleDefinition) {
54          super(availabilityDefinition, ruleDefinition);
55      }
56  
57      @Override
58      protected boolean isAvailableFor(Item item) {
59          try {
60              return isAvailableForJcrItem(item);
61          } catch (RepositoryException e) {
62              throw new RuntimeRepositoryException(e);
63          }
64      }
65  
66      protected abstract boolean isAvailableForJcrItem(Item item) throws RepositoryException;
67  }