org.jvnet.hk2.config.ConfigMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
There is a newer version: 7.2024.1.Alpha1
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2007-2017 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
 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
 * or 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 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 org.jvnet.hk2.config;

/**
 * Constant names used in the metadata for configurable inhabitants.
 *
 * @author Kohsuke Kawaguchi
 */
public class ConfigMetadata {
    /**
     * Fully qualified name of the target class that an injector works with.
     */
    public static final String TARGET = "target";

    /**
     * Contracts that the target type implements.
     */
    public static final String TARGET_CONTRACTS = "target-contracts";

    /**
     * Target habitats in which this service should reside.
     */
    public static final String TARGET_HABITATS = "target-habitats"; //Should be same as GeneratorRunner.TARGET_HABITATS

    /**
     * If the {@link #TARGET target type} is keyed, the FQCN that defines
     * the key field. This type is always assignable from the target type.
     *
     * This allows a symbol space to be defined on a base class B, and
     * different subtypes can participate.
     */
    public static final String KEYED_AS = "keyed-as";

    /**
     * The name of the property used as a key for exposing inhabitants,
     * as well as resolving references.
     *
     * 
     * This is either "@attr" or "<element>" indicating
     * where the key is read.
     * 
     * @see Attribute#key()
     * @see Element#key()
     */
    public static final String KEY = "key";
}