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 java.io.Serializable;
022
023import org.nuxeo.common.xmap.annotation.XNode;
024import org.nuxeo.common.xmap.annotation.XNodeList;
025import org.nuxeo.common.xmap.annotation.XObject;
026
027/**
028 * @since 5.5
029 */
030@XObject("layoutConverter")
031public class LayoutConverterDescriptor implements Serializable, Comparable<LayoutConverterDescriptor> {
032
033    private static final long serialVersionUID = 1L;
034
035    @XNode("@name")
036    String name;
037
038    @XNode("@order")
039    int order = 0;
040
041    @XNode("converter-class")
042    String converterClassName;
043
044    @XNodeList(value = "categories/category", type = String[].class, componentType = String.class)
045    String[] categories = new String[0];
046
047    public String getName() {
048        return name;
049    }
050
051    public String getConverterClassName() {
052        return converterClassName;
053    }
054
055    public String[] getCategories() {
056        return categories;
057    }
058
059    public int getOrder() {
060        return order;
061    }
062
063    @Override
064    public int compareTo(LayoutConverterDescriptor otherConverter) {
065        int cmp = order - otherConverter.order;
066        if (cmp == 0) {
067            // make sure we have a deterministic sort
068            cmp = name.compareTo(otherConverter.name);
069        }
070        return cmp;
071    }
072
073}