001/*
002 * (C) Copyright 2015 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 *     Nicolas Chapurlat <nchapurlat@nuxeo.com>
018 */
019
020package org.nuxeo.ecm.core.io.registry.context;
021
022/**
023 * Possible depth values for "marshaller-to-marshaller" calls (to avoid the infinite loops).
024 *
025 * @since 7.2
026 */
027public enum DepthValues {
028
029    /**
030     * Loads / Fetches / Enriches the first level element(s).
031     */
032    root,
033
034    /**
035     * Loads / Fetches / Enriches the first level element(s) and its (their) children.
036     */
037    children,
038
039    /**
040     * Loads / Fetches / Enriches the first level element(s), its (their) children, and the grandchildren.
041     */
042    max;
043
044    /**
045     * Gets the corresponding depth value.
046     *
047     * @return The depth.
048     * @since 7.2
049     */
050    public int getDepth() {
051        return ordinal() + 1;
052    }
053
054}