001/*
002 * Copyright 2012-2017 the original author or authors.
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
017package org.springframework.boot.autoconfigure.condition;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025import org.springframework.boot.cloud.CloudPlatform;
026import org.springframework.context.annotation.Conditional;
027
028/**
029 * {@link Conditional} that matches when the specified cloud platform is active.
030 *
031 * @author Madhura Bhave
032 * @since 1.5.0
033 */
034@Target({ ElementType.TYPE, ElementType.METHOD })
035@Retention(RetentionPolicy.RUNTIME)
036@Documented
037@Conditional(OnCloudPlatformCondition.class)
038public @interface ConditionalOnCloudPlatform {
039
040        /**
041         * The {@link CloudPlatform cloud platform} that must be active.
042         * @return the expected cloud platform
043         */
044        CloudPlatform value();
045
046}