org.semanticweb.owlapi.model.PriorityCollectionSorting Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of owlapi-osgidistribution Show documentation
There is a newer version: 5.5.0
Show newest version
/* This file is part of the OWL API.
 * The contents of this file are subject to the LGPL License, Version 3.0.
 * Copyright 2014, The University of Manchester
 * 
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
 *
 * Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0 in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */
package org.semanticweb.owlapi.model;

import java.util.Collections;
import java.util.List;

import org.semanticweb.owlapi.util.HasPriorityComparator;

/**
 * Specifies how PriorityCollection should sort its entries.
 * 
 * @author Ignazio
 * @since 4.0.2
 */
public enum PriorityCollectionSorting implements ByName {
    /** Always keep the collection sorted by HasPriority annotation values. */
    ALWAYS {

        @Override
        public  List sort(List list) {
            Collections.sort(list, new HasPriorityComparator<>());
            return list;
        }

        @Override
        public  List sortInputSet(List list) {
            return sort(list);
        }
    },
    /**
     * Only sort according to HasPriority annotation when a Set is passed in, do not sort otherwise.
     * This allows for fine tuning of the order in which entries appear, but does not lose the
     * default prioritisation. This is important for parsers. When this sorting is used, addition of
     * new elements causes the elements to be added at the front of the collection (First In, First
     * Out)
     */
    ON_SET_INJECTION_ONLY {

        @Override
        public  List sort(List list) {
            return list;
        }

        @Override
        public  List sortInputSet(List list) {
            Collections.sort(list, new HasPriorityComparator<>());
            return list;
        }
    },
    /**
     * Sorting of entries is disabled. When this sorting is used, addition of new elements causes
     * the elements to be added at the front of the collection (First In, First Out)
     */
    NEVER {

        @Override
        public  List sort(List list) {
            return list;
        }

        @Override
        public  List sortInputSet(List list) {
            return list;
        }
    };

    /**
     * @param list list to sort
     * @param  type of elements
     * @return sorted list
     */
    public abstract  List sort(List list);

    /**
     * @param list list to sort
     * @param  type of elements
     * @return sorted list
     */
    public abstract  List sortInputSet(List list);

    @Override
    public PriorityCollectionSorting byName(CharSequence name) {
        return valueOf(name.toString());
    }
}