org.eclipse.microprofile.config.inject.package-info Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016-2017 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * Licensed 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.
 */

/**
 * CDI Support for MicroProfile Config
 *
 * 
 * MicroProfile Config also supports injection via a JSR-330 DI container:
 *
 * 
 *  @Inject
 *  @ConfigProperty(name="myproject.some.endpoint.url");
 *  private String restUrl;
 * 
 *
 * 
 * The following types can be injected:
 *
 * 

 * T where T is a Type where a {@link org.eclipse.microprofile.config.spi.Converter} exists and the
 * property must exist.
 * Optional<T> where T is a Type where a {@link org.eclipse.microprofile.config.spi.Converter}
 * exists where the property may exist.
 * Provider<T> where T is a Type where a {@link org.eclipse.microprofile.config.spi.Converter}
 * exists where the property may exist.
 * 
 *
 * @author Mark Struberg
 * @author Emily Jiang
 */
@org.osgi.annotation.versioning.Version("2.0")
package org.eclipse.microprofile.config.inject;