1 /*
   2  * Copyright (c) 2012, 2014, Oracle and/or its affiliates.
   3  * All rights reserved. Use is subject to license terms.
   4  *
   5  * This file is available and licensed under the following license:
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  *  - Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *  - Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the distribution.
  16  *  - Neither the name of Oracle Corporation nor the names of its
  17  *    contributors may be used to endorse or promote products derived
  18  *    from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32 package com.oracle.javafx.scenebuilder.kit.library;
  33 
  34 import java.util.ArrayList;
  35 import java.util.Comparator;
  36 import java.util.List;
  37 
  38 /**
  39  *
  40  * @treatAsPrivate
  41  */
  42 public class BuiltinSectionComparator implements Comparator<String> {
  43 
  44     private static final List<String> orderedSections = new ArrayList<>();
  45 
  46     static {
  47         orderedSections.add(BuiltinLibrary.TAG_CONTAINERS);
  48         orderedSections.add(BuiltinLibrary.TAG_CONTROLS);
  49         orderedSections.add(BuiltinLibrary.TAG_MENU);
  50         orderedSections.add(BuiltinLibrary.TAG_MISCELLANEOUS);
  51         orderedSections.add(BuiltinLibrary.TAG_SHAPES);
  52         orderedSections.add(BuiltinLibrary.TAG_CHARTS);
  53         orderedSections.add(BuiltinLibrary.TAG_3D);
  54     }
  55 
  56 
  57     /*
  58      * Comparator
  59      */
  60 
  61     @Override
  62     public int compare(String section1, String section2) {
  63         assert section1 != null;
  64         assert section2 != null;
  65 
  66         final int index1 = orderedSections.indexOf(section1);
  67         final int index2 = orderedSections.indexOf(section2);
  68         final int result;
  69 
  70         if ((index1 != -1) && (index2 != -1)) {
  71             // section1 and section2 are both predefined names
  72             result = Integer.compare(index1, index2);
  73         } else if (index1 != -1) {
  74             // only section1 is predefined -> goes before section2
  75             result = +1;
  76         } else if (index2 != -1) {
  77             // only section2 is predefined -> goes before section1
  78             result = -1;
  79         } else {
  80             // section1 and section2 are both custom
  81             result = section1.compareTo(section2);
  82         }
  83 
  84         return result;
  85     }
  86 
  87 }