View Javadoc
1   /**
2    * This file Copyright (c) 2016 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.config.registry.decoration;
35  
36  import info.magnolia.config.registry.DefinitionProvider;
37  import info.magnolia.module.ModuleRegistry;
38  import info.magnolia.module.model.ModuleDefinition;
39  
40  import java.util.Comparator;
41  
42  import com.google.common.base.Predicate;
43  import com.google.common.collect.ComparisonChain;
44  
45  /**
46   * Common {@link DefinitionDecorator}-related functions.
47   */
48  public class DefinitionDecorators {
49  
50      public static <T> Predicate<DefinitionDecorator<T>> appliesTo(final DefinitionProvider<T> definitionProvider) {
51          return new Predicate<DefinitionDecorator<T>>() {
52              @Override
53              public boolean apply(DefinitionDecorator<T> decorator) {
54                  return decorator.appliesTo(definitionProvider);
55              }
56          };
57      }
58  
59      public static Comparator<DefinitionDecorator> moduleDependencyBasedComparator(final ModuleRegistry moduleRegistry) {
60          return new Comparator<DefinitionDecorator>() {
61              @Override
62              public int compare(DefinitionDecorator o1, DefinitionDecorator o2) {
63                  final String firstModule = o1.metadata().getSourceModule();
64                  final String secondModule = o2.metadata().getSourceModule();
65  
66                  boolean isFirstModuleRegistered = moduleRegistry.isModuleRegistered(firstModule);
67                  boolean isSecondModuleRegistered = moduleRegistry.isModuleRegistered(secondModule);
68  
69                  if (!isFirstModuleRegistered || !isSecondModuleRegistered) {
70                      // Registered module wins over non-registered, two non-registered module are considered equal
71                      return ComparisonChain.start().compare(isFirstModuleRegistered, isSecondModuleRegistered).result();
72                  }
73  
74                  final ModuleDefinition d1 = moduleRegistry.getDefinition(firstModule);
75                  final ModuleDefinition d2 = moduleRegistry.getDefinition(secondModule);
76  
77                  return ComparisonChain.start().
78                          compare(moduleRegistry.getModuleDefinitions().indexOf(d1),
79                                  moduleRegistry.getModuleDefinitions().indexOf(d2)).
80                          result();
81              }
82          };
83      }
84  
85  }