001/*
002 * (C) Copyright 2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Anahide Tchertchian
018 */
019package org.nuxeo.ecm.platform.forms.layout.descriptors;
020
021import org.nuxeo.common.xmap.annotation.XNode;
022import org.nuxeo.common.xmap.annotation.XNodeList;
023import org.nuxeo.common.xmap.annotation.XObject;
024
025/**
026 * @since 5.5
027 */
028@XObject("widgetConverter")
029public class WidgetConverterDescriptor implements Comparable<WidgetConverterDescriptor> {
030
031    @XNode("@name")
032    String name;
033
034    @XNode("@order")
035    int order = 0;
036
037    @XNode("converter-class")
038    String converterClassName;
039
040    @XNodeList(value = "categories/category", type = String[].class, componentType = String.class)
041    String[] categories = new String[0];
042
043    public String getName() {
044        return name;
045    }
046
047    public String getConverterClassName() {
048        return converterClassName;
049    }
050
051    public String[] getCategories() {
052        return categories;
053    }
054
055    public int getOrder() {
056        return order;
057    }
058
059    @Override
060    public int compareTo(WidgetConverterDescriptor otherConverter) {
061        int cmp = order - otherConverter.order;
062        if (cmp == 0) {
063            // make sure we have a deterministic sort
064            cmp = name.compareTo(otherConverter.name);
065        }
066        return cmp;
067    }
068}