001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.metamodel.spec;
021
022public enum Persistability {
023    /**
024     * Marks a class as being persistable, but only by under application program
025     * control.
026     */
027    PROGRAM_PERSISTABLE("Program Persistable", true),
028    /**
029     * Marks a class as transient - such an object cannot be persisted.
030     */
031    TRANSIENT("Transient", false),
032    /**
033     * Marks a class as being persistable by the user (or under application
034     * program control).
035     */
036    USER_PERSISTABLE("User Persistable", true);
037
038    private final String name;
039    private final boolean persistable;
040
041    private Persistability(final String name, final boolean persistable) {
042        this.name = name;
043        this.persistable = persistable;
044    }
045
046    public boolean isPersistable() {
047        return persistable;
048    }
049
050    @Override
051    public String toString() {
052        return name;
053    }
054}