org.apache.cayenne.ExtendedEnumeration Maven / Gradle / Ivy

Go to download
/*****************************************************************
 *   Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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.apache.cayenne;

/**
 * An interface that Enum classes may implement to map enum instances to arbitrary DB
 * values that do not match the enum names or positions.
 * 
 * @since 3.0
 */
public interface ExtendedEnumeration {

    /**
     * Return the value to be stored in the database for this enumeration. In actuality,
     * this should be an Integer or a String.
     */
    Object getDatabaseValue();
}