ComponentScope.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2008-2012 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.jersey.core.spi.component;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

/**
 * The scope contract for a component.
 */
public enum ComponentScope {

    /**
     * Declares the scope of the component is a singleton whose instance
     * is valid for the scope of the running application.
     */
    Singleton,

    /**
     * Declares that the scope of the component is per request whose instance
     * is valid for the scope of the current HTTP request and response.
     */
    PerRequest,

    /**
     * Declares that the scope of the component is undefined.
     */
    Undefined;

    /**
     * A immutable list comprising of the scopes Undefined and
     * Singleton, in that order.
     */
    public static final List<ComponentScope> UNDEFINED_SINGLETON =
            Collections.unmodifiableList(Arrays.asList(ComponentScope.Undefined, ComponentScope.Singleton));

    /**
     * A immutable list comprising of the scopes PerRequest, Undefined and
     * Singleton, in that order.
     */
    public static final List<ComponentScope> PERREQUEST_UNDEFINED_SINGLETON =
            Collections.unmodifiableList(Arrays.asList(ComponentScope.PerRequest, ComponentScope.Undefined, ComponentScope.Singleton));

    /**
     * A immutable list comprising of the scopes PerRequest and
     * Undefined, in that order.
     */
    public static final List<ComponentScope> PERREQUEST_UNDEFINED =
            Collections.unmodifiableList(Arrays.asList(ComponentScope.PerRequest, ComponentScope.Undefined));
}