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.system.JavaVersion;
026import org.springframework.context.annotation.Conditional;
027
028/**
029 * {@link Conditional} that matches based on the JVM version the application is running
030 * on.
031 *
032 * @author Oliver Gierke
033 * @author Phillip Webb
034 * @author Andy Wilkinson
035 * @since 1.1.0
036 */
037@Target({ ElementType.TYPE, ElementType.METHOD })
038@Retention(RetentionPolicy.RUNTIME)
039@Documented
040@Conditional(OnJavaCondition.class)
041public @interface ConditionalOnJava {
042
043        /**
044         * Configures whether the value configured in {@link #value()} shall be considered the
045         * upper exclusive or lower inclusive boundary. Defaults to
046         * {@link Range#EQUAL_OR_NEWER}.
047         * @return the range
048         */
049        Range range() default Range.EQUAL_OR_NEWER;
050
051        /**
052         * The {@link JavaVersion} to check for. Use {@link #range()} to specify whether the
053         * configured value is an upper-exclusive or lower-inclusive boundary.
054         * @return the java version
055         */
056        JavaVersion value();
057
058        /**
059         * Range options.
060         */
061        enum Range {
062
063                /**
064                 * Equal to, or newer than the specified {@link JavaVersion}.
065                 */
066                EQUAL_OR_NEWER,
067
068                /**
069                 * Older than the specified {@link JavaVersion}.
070                 */
071                OLDER_THAN
072
073        }
074
075}