Cascadeable.java

/**
 * ***************************************************************************
 * Copyright (c) 2010 Qcadoo Limited
 * Project: Qcadoo Framework
 * Version: 1.4
 *
 * This file is part of Qcadoo.
 *
 * Qcadoo is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ***************************************************************************
 */
package com.qcadoo.model.api.types;

import org.apache.commons.lang3.StringUtils;

public interface Cascadeable {

    /**
     * Cascade type.
     */
    enum Cascade {
        NULLIFY("nullify"), DELETE("delete");

        private final String stringValue;

        private Cascade(final String stringValue) {
            this.stringValue = stringValue;
        }

        public static Cascade parse(final String stringValue) {
            if (StringUtils.isBlank(stringValue)) {
                return NULLIFY;
            }
            for (final Cascade cascadeType : Cascade.values()) {
                if (cascadeType.getStringValue().equalsIgnoreCase(stringValue)) {
                    return cascadeType;
                }
            }
            throw new IllegalArgumentException(String.format("Illegal 'cascade' attribute value '%s'.", stringValue));
        }

        public String getStringValue() {
            return stringValue;
        }
    }

    /**
     * Returns cascade type.
     * 
     * @return cascade type
     */
    Cascade getCascade();

}